Skip to content

fix(jaas-usage): use sed to replace jaas with juju jaas in the index.md doc#1892

Merged
SimoneDutto merged 5 commits intocanonical:v3from
SimoneDutto:fix-jaas-usage
Mar 5, 2026
Merged

fix(jaas-usage): use sed to replace jaas with juju jaas in the index.md doc#1892
SimoneDutto merged 5 commits intocanonical:v3from
SimoneDutto:fix-jaas-usage

Conversation

@SimoneDutto
Copy link
Contributor

Description

In the doc right now we document jaas commands as:

Usage
jaas show-model [options] <model>

This is not correct because you can't run jaas commands by itself, and you need to run them via juju.

I've tried to use:

jaasCmd := jujucmd.NewSuperCommand(jujucmd.SuperCommandParams{
		Name: "jaas",
		Doc:  jaasDoc,
               	UsagePrefix: "juju"
	})

the problem is that UsagePrefix is not used to generate documentation, so the easier thing was just to amend our generate script to fix the doc.

@SimoneDutto SimoneDutto requested a review from a team as a code owner March 3, 2026 14:37
Copy link
Contributor

@luci1900 luci1900 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose.

@SimoneDutto SimoneDutto merged commit ca834d3 into canonical:v3 Mar 5, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants