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

Show example output of command #61

Open
pederhan opened this issue Apr 11, 2023 · 0 comments
Open

Show example output of command #61

pederhan opened this issue Apr 11, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pederhan
Copy link
Member

pederhan commented Apr 11, 2023

On the in-depth documentation page of each command, there should be a (collapsed?) section showing the typical output of the command.

We need to figure out if this should be text or an image. If we do text, we have no way to colorize the output unless we use HTML. In order to do HTML, we need to record Rich console sessions and export them as HTML. That might be too much work for now, as this process would definitely require automation, and there is currently no test Harbor instance that can be relied on to provide this service.

Either way, the examples should probably go in docs/commands/examples/<full_name_of_command>.<ext>, i.e.: docs/commands/examples/artifact_list.png

The template (docs/templates/category.md.j2) would then have to be modified to load this file based on the name of the command currently being rendered.

@pederhan pederhan added the documentation Improvements or additions to documentation label Apr 11, 2023
@pederhan pederhan added this to Harbor Apr 11, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant