Skip to content

docs(website): improve section for cli shorthands #827

@AlessandroPomponio

Description

@AlessandroPomponio

The only documentation of the shorthands is in code blocks associated with individual commands in CLI reference that lists RESOURCE TYPES that can be used with the command e.g. https://ibm.github.io/ado/getting-started/ado/#ado-create.

This is problematic as here is no string related to "shorthands" associated with these sections that will show them in search; or alternativelyy a top-level section about the shorthands available that could show in search. So when you search for "shorthands" or "short resource names" etc. you get nothing.

As a side note, the shorthands should not be in a code-block

Example:

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions