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 -h text update #4330

Open
SophCarp opened this issue Sep 17, 2024 · 3 comments
Open

azd -h text update #4330

SophCarp opened this issue Sep 17, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation ux impact ux improvements
Milestone

Comments

@SophCarp
Copy link
Collaborator

SophCarp commented Sep 17, 2024

Current azd -h Experience

The Azure Developer CLI is an open-source tool that helps onboard and manage your application on Azure

Usage
  azd [command]

Commands
  Configure and develop your app
    auth        : Authenticate with Azure.
    config      : Manage azd configurations (ex: default Azure subscription, location).
    hooks       : Develop, test and run hooks for an application. (Beta)
    init        : Initialize a new application.
    restore     : Restores the application's dependencies. (Beta)
    template    : Find and view template details. (Beta)

  Manage Azure resources and app deployments
    deploy      : Deploy the application's code to Azure.
    down        : Delete Azure resources for an application.
    env         : Manage environments.
    package     : Packages the application's code to be deployed to Azure. (Beta)
    provision   : Provision the Azure resources for an application.
    up          : Provision Azure resources, and deploy your project with a single command.

  Monitor, test and release your app
    monitor     : Monitor a deployed application. (Beta)
    pipeline    : Manage and configure your deployment pipelines. (Beta)
    show        : Display information about your app and its resources.

  About, help and upgrade
    version     : Print the version number of Azure Developer CLI.

Flags
    -C, --cwd string    : Sets the current working directory.
        --debug         : Enables debugging and diagnostics logging.
        --docs          : Opens the documentation for azd in your web browser.
    -h, --help          : Gets help for azd.
        --no-prompt     : Accepts the default value instead of prompting, or it fails if there is no default.

Use azd [command] --help to view examples and more information about a specific command.

Deploying a sample application
Initialize from a sample application by running the azd init --template [template name] command in an empty directory.
Then, run azd up to get the application up-and-running in Azure.

To view a curated list of sample templates, run azd template list.
To view all available sample templates, including those submitted by the azd community, visit: https://azure.github.io/awesome-azd.

Find a bug? Want to let us know how we're doing? Fill out this brief survey: https://aka.ms/azure-dev/hats.

Option 1

Beta Commands get their own section

The Azure Developer CLI is an open-source tool that helps onboard and manage your application on Azure

Usage
  azd [command]

Commands
  Configure and develop your app
    auth        : Authenticate with Azure.
    config      : Manage azd configurations (ex: default Azure subscription, location).
    init        : Initialize a new application.


  Manage Azure resources and app deployments
    deploy      : Deploy the application's code to Azure.
    down        : Delete Azure resources for an application.
    env         : Manage environments.
    provision   : Provision the Azure resources for an application.
    up          : Provision Azure resources, and deploy your project with a single command.

  Monitor, test and release your app
    show        : Display information about your app and its resources.

  About, help and upgrade
    version     : Print the version number of Azure Developer CLI.

  Beta Commands
    hooks       : Develop, test and run hooks for an application.
    monitor     : Monitor a deployed application.
    package     : Packages the application's code to be deployed to Azure.
    pipeline    : Manage and configure your deployment pipelines.
    restore     : Restores the application's dependencies. 
    template    : Find and view template details.

Flags
    -C, --cwd string    : Sets the current working directory.
        --debug         : Enables debugging and diagnostics logging.
        --docs          : Opens the documentation for azd in your web browser.
    -h, --help          : Gets help for azd.
        --no-prompt     : Accepts the default value instead of prompting, or it fails if there is no default.

Use azd [command] --help to view examples and more information about a specific command.

Deploying a sample application
Initialize from a sample application by running the azd init --template [template name] command in an empty directory.
Then, run azd up to get the application up-and-running in Azure.

To view a curated list of sample templates, run azd template list.
To view all available sample templates, including those submitted by the azd community, visit: https://azure.github.io/awesome-azd.

Find a bug? Want to let us know how we're doing? Fill out this brief survey: https://aka.ms/azure-dev/hats.

Option 2

Beta commands get moved to the bottom of each command group, and the (Beta) label gets moved to the beginning of the description

The Azure Developer CLI is an open-source tool that helps onboard and manage your application on Azure

Usage
  azd [command]

Commands
  Configure and develop your app
    auth        : Authenticate with Azure.
    config      : Manage azd configurations (ex: default Azure subscription, location).
    init        : (Beta) Initialize a new application.
    hooks       : (Beta) Develop, test and run hooks for an application.
    restore     : (Beta) Restores the application's dependencies. 
    template    : (Beta) Find and view template details. 

  Manage Azure resources and app deployments
    deploy      : Deploy the application's code to Azure.
    down        : Delete Azure resources for an application.
    env         : Manage environments.
    provision   : Provision the Azure resources for an application.
    up          : Provision Azure resources, and deploy your project with a single command.
    package     : (Beta) Packages the application's code to be deployed to Azure. (Beta)

  Monitor, test and release your app
    show        : Display information about your app and its resources.
    monitor     : (Beta) Monitor a deployed application. 
    pipeline    : (Beta) Manage and configure your deployment pipelines. 


  About, help and upgrade
    version     : Print the version number of Azure Developer CLI.

Flags
    -C, --cwd string    : Sets the current working directory.
        --debug         : Enables debugging and diagnostics logging.
        --docs          : Opens the documentation for azd in your web browser.
    -h, --help          : Gets help for azd.
        --no-prompt     : Accepts the default value instead of prompting, or it fails if there is no default.

Use azd [command] --help to view examples and more information about a specific command.

Deploying a sample application
Initialize from a sample application by running the azd init --template [template name] command in an empty directory.
Then, run azd up to get the application up-and-running in Azure.

To view a curated list of sample templates, run azd template list.
To view all available sample templates, including those submitted by the azd community, visit: https://azure.github.io/awesome-azd.

Find a bug? Want to let us know how we're doing? Fill out this brief survey: https://aka.ms/azure-dev/hats.
@SophCarp SophCarp self-assigned this Sep 17, 2024
@SophCarp
Copy link
Collaborator Author

@kristenwomack @Austinauth @gkulin @rajeshkamal5050 here's the proposal from this morning.

@rajeshkamal5050 rajeshkamal5050 added documentation Improvements or additions to documentation ux improvements ux impact labels Sep 18, 2024
@rajeshkamal5050 rajeshkamal5050 added this to the On Deck milestone Sep 18, 2024
@SophCarp
Copy link
Collaborator Author

PR: https://github.com/Azure/azure-dev-pr/pull/1710

@SophCarp
Copy link
Collaborator Author

10/31 Weekly Review: I made this PR to fix up the work. I need to fix the PR to send to the azure-dev repo not the private repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ux impact ux improvements
Projects
None yet
Development

No branches or pull requests

2 participants