Skip to content

Remove "rhoas" prefix for commands in the CLI command ref #1226

@bhardesty

Description

@bhardesty

Feature or problem description

In the CLI command ref, the title of each command is the full rhoas command, including the "rhoas" prefix. For example:
https://github.com/redhat-developer/app-services-cli/blob/modular-docs/modules/ref-cli-cluster-bind.adoc#rhoas-cluster-bind

When you're looking at the TOC in the command ref, this actually makes it more difficult to find the command you're looking for (since every command starts with "rhoas").

(This is related to #1225, but I'm raising it as a separate issue since it can be done separately.)

Proposed solution

To increase findability in the command ref, I propose that we remove the "rhoas" prefix from each .adoc command file that is included in the CLI command ref. This would apply only to the title of the .adoc file.

Additional context

A separate .adoc file is generated for each rhoas command by this script: https://github.com/redhat-developer/app-services-cli/blob/main/pkg/doc/modular_adoc_docs.go

Currently, the script sets the title of each command .adoc file to be the command's full command path: https://github.com/redhat-developer/app-services-cli/blob/main/pkg/doc/modular_adoc_docs.go#L213

To implement the proposed solution, the script would need to be updated to set the title of each command .adoc file to be the command's command path without the "rhoas" part of the command.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions