Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azd docs command and flag #1433

Closed
Austinauth opened this issue Jan 20, 2023 · 5 comments · Fixed by #2463
Closed

azd docs command and flag #1433

Austinauth opened this issue Jan 20, 2023 · 5 comments · Fixed by #2463

Comments

@Austinauth
Copy link

Related to #822

Description

We'd like to propose adding an azd docs command and an azd <command> --docs flag.

Behavior

Behavior for this command should be fairly simple. Inputing azd docs should open the azd reference page in a new browser window (see Figure 1.A below).

Inputing azd <command> --docs should behave similarly, opening a new browser window to the reference docs section for the specific command entered (see Figure 1.B below).

Figure 1.A
image

Figure 1.B
image

@ghost ghost added the needs-triage For new issues label Jan 20, 2023
@savannahostrowski savannahostrowski added this to the Release 0.8 milestone Jan 20, 2023
@savannahostrowski
Copy link
Contributor

This should be added before GA.

@rajeshkamal5050
Copy link

Moving to Gallium @savannahostrowski

@savannahostrowski
Copy link
Contributor

As a start here, we should support just a top-level docs command.

The flag will require some documentation updates. @gkulin for your consideration!

@ellismg
Copy link
Member

ellismg commented May 30, 2023

Do we need a top level docs command or could we have azd --docs behave as azd docs would?

I do think the idea of having some browser based view of our docs is a good idea, I'm less sure we need an entire top level command to do (especially if we are going to support --docs on all the sub commands).

@savannahostrowski
Copy link
Contributor

Now that you mention it, I'd probably prefer a flag to avoid bloating the top-level commands.

I don't think we need to worry about more granular docs right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants