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

README: Provide more execution examples #27

Open
nodeg opened this issue Apr 23, 2024 · 0 comments
Open

README: Provide more execution examples #27

nodeg opened this issue Apr 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nodeg
Copy link
Member

nodeg commented Apr 23, 2024

Description

It would be nice to have more examples in the README, e.g. for building the current docs for Uyuni.

Example

For SUMA I run

./uyuni-docs-helper -o suma -c obs-packages-suma-en -p suma

but I do not clearly see what command (-c) I need to use for Uyuni.

The help is not clear on that:

❯ ./uyuni-docs-helper -h

Build the Uyuni doc using a container and (optionally) serve it for verification via HTTP

Syntax:

uyuni-docs-helper <ARGUMENTS>

Mandatory arguments:

-p|--product <uyuni|suma>   Build the documentation for either Uyuni or SUSE Manager
-c|--command <make command> Use the desired command to build html/pdf, html&pdf, etc...
                            for example: 'all-uyuni'. You can use 'help' to list all
                            possible commands. Be aware you still need to specify
                            one source for this to work
(...)

Maybe we could also add all the possible commands to the help menu, too.

@nodeg nodeg added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 23, 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
None yet
Development

No branches or pull requests

1 participant