fix steps in getting started guide and warnings from docusaurus #1537

[markscott-ms]

Description

This updates the CALM getting started / quick 5 minute guide to ensure it works front to back, and the two are consistent. Thanks @yt-ms for going through the guide and giving feedback on some issues.

As part of this it also addresses a warning that docusaurus outputs when a calm docify website is produced.

Type of Change

• 🐛 Bug fix (non-breaking change which fixes an issue)
• ✨ New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 📚 Documentation update
• 🎨 Code style/formatting changes
• ♻️ Refactoring (no functional changes)
• ⚡ Performance improvements
• ✅ Test additions or updates
• 🔧 Chore (maintenance, dependencies, CI, etc.)

Affected Components

• CLI (cli/)
• Shared (shared/)
• CALM Widgets (calm-widgets/)
• CALM Hub (calm-hub/)
• CALM Hub UI (calm-hub-ui/)
• Documentation (docs/)
• VS Code Extension (calm-plugins/vscode/)
• Dependencies
• CI/CD

Commit Message Format ✅

Testing

• I have tested my changes locally
• I have added/updated unit tests
• All existing tests pass

Checklist

• My commits follow the conventional commit format
• I have updated documentation if necessary
• I have added tests for my changes (if applicable)
• My changes follow the project's coding standards

[LeighFinegold]

Is this a new suggested template for PR Changes?

[markscott-ms]

It appears so! I was prompted to use it.

I need to fix tests though.

[LeighFinegold]

Upon running this locally myself, I noticed that actually the replace function is incorrectly changing the url to invalid urls.

The aim of this logic was originally put in when the docify website mode also had control requirements on the side panel with special rendered pages built with a json viewer control.

It was removed from the side-panel upon a review from @rocketstack-matt and @jpgough-ms prior to QCON 2024.

The purpose of rewriting urls was trying to aid in scenarios where someone was specifying their own control-requirement schemas via a local mapping file.

I think we should
a). Remove this altogether, or
b) Perform a bug fix such that it is only rewriting urls for user provided schemas.

I raised #1543 as a stub