Skip to content

DOCS: Add documentation for directUrlAuth plugin - #3124

Open
jimthompson5802 wants to merge 16 commits into
finos:mainfrom
jimthompson5802:directurl-auth-plugin-docs
Open

jimthompson5802 wants to merge 16 commits into
finos:mainfrom
jimthompson5802:directurl-auth-plugin-docs

Conversation

@jimthompson5802

@jimthompson5802 jimthompson5802 commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

Description

CALM Docs: Expanded the CLI and documentation with setup examples and a dedicated Direct URL authentication plugin guide, including Mermaid diagrams.

CALM CLI: Updated CLI help information with configuration support for Direct URL authentication plugins, including plugin paths, optional configuration, and authenticated host allow-lists. Added tests for option persistence, host merging and deduplication, and scalar replacement behavior.

$ calm init-config --help
Usage: calm init-config [options]

Create or update the CALM CLI configuration file (~/.calm.json).

Options:
  --allowed-remote-hosts <hosts>                 Comma-separated list of trusted remote hosts to allow for direct URL loading
  --calm-hub-url <url>                           URL to a trusted file location (e.g. CALMHub) to allow for direct URL loading
                                                 of CALM documents
  --auth-plugin-path <path>                      Path to the CALM Hub authentication plugin
  --direct-url-auth-module <path>                Optional path to the direct URL authentication plugin module
  --direct-url-auth-config-path <path>           Optional config path for the direct URL authentication plugin module
  --direct-url-auth-authenticated-hosts <hosts>  If direct-url-auth-module is specified, this specifies a comma-separated list
                                                 of hostnames requiring direct URL authentication plugin module
  -h, --help                                     display help for command

Documentation related to #3035

A local test of the updated and new pages in docs/docs//working-with-calm documentation

image image image image

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/)
  • Schema (calm/)
  • CALM AI (calm-ai/)
  • CALM Hub (calm-hub/)
  • CALM Hub UI (calm-hub-ui/)
  • CALM Server (calm-server/)
  • CALM Widgets (calm-widgets/)
  • Documentation (docs/)
  • Shared (shared/)
  • 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

npm test --workspace cli -- --reporter=dot passed 29 test files and 683 tests.

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

@github-actions github-actions Bot added cli Affects `cli` code config docs Improvements of additions to documentation labels Sep 20, 2026
@jimthompson5802

jimthompson5802 commented Sep 20, 2026

Copy link
Copy Markdown
Contributor Author

@markscott-ms This is the documentation PR for the directUrlAuth plugin. I need some guidance on this. Since I wanted to use mermaid diagram in one of the documentation pages, I added dependency @docusaurus/theme-mermaid 3.10.2 in docs/pacakges.json. This now causes a failure in the npm ci command in GH Actions workflow. I can recreate the same error locally by running the npm ci command.
image

I can resolve this issue by running at the repo root level rm -fr node_modules/ package-lock.json && npm install. However this command updates the package-lock.json at the repo root level.

I remember you and I had a discussion a while back that I should not commit changes to package-lock.json.

In this particular situation, where I added a dependency to docs/package.json, I think the resolution is

# at the repo root

$ rm -fr node_modules/ package-lock.json

$ npm install

# commit updated package-lock.json and push to my feature branch

Looking for some guidance on how to handle this situation.

@willosborne I added help info for the calm init-config command for the new options that are associated with the directUrlAuth plugin.
image

@jimthompson5802

Copy link
Copy Markdown
Contributor Author

@markscott-ms Thanks for the advice. all tests now pass.

I'll mark this ready for review and will put this on the agenda for this week's office hours.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli Affects `cli` code config docs Improvements of additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant