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

Create CLI documentation #64

Open
SchoolGuy opened this issue Nov 14, 2024 · 0 comments
Open

Create CLI documentation #64

SchoolGuy opened this issue Nov 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@SchoolGuy
Copy link
Member

Is your feature request related to a problem?

As a user
I want to be able to read extensive documentation
so that I can easier understand how to use the CLI.

Provide a detailed description of the proposed feature

Currently, the CLI documentation is provided on the server ReadTheDocs repository. This is fine since the current built-in CLI is present there. Since the CLI will be maintained in this repository, it would be better to pair the documentation with the tool.

The user guides should stay inside the backend as many of the topics are tightly integrated with the available capabilities of the Cobbler host machine.

Alternatives you've considered

None

Additional information

None

@SchoolGuy SchoolGuy added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 14, 2024
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 enhancement New feature or request
Projects
Status: To do
Development

No branches or pull requests

1 participant