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

Harbor-CLI Documentation #580

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

Althaf66
Copy link

Created documentation for Harbor CLI.

If any changes is needed, please comment
Here is the preview...

image

@Vad1mo
Copy link
Member

Vad1mo commented Oct 12, 2024

good work, the fininal result is what I had in mind.
Regarding the .md files. what are they part of that PR? shouldn't they be fetched when cli-docs.sh run?

What is the point checking them in?

Signed-off-by: ALTHAF <[email protected]>
@Althaf66
Copy link
Author

I include the md files to show the final output. Before executing cli-docs.sh file, need to merge this PR.

@OrlinVasilev
Copy link
Member

Why it's under content ? it should be under docs can you move it
Content is primarily for blogs

Copy link
Member

@Vad1mo Vad1mo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good progress, I think you are missing the step to call cli-docs.sh from the makefile in the step production-build.

Bildschirmfoto 2024-10-15 um 15 39 02

@Vad1mo
Copy link
Member

Vad1mo commented Oct 15, 2024

Why it's under content ? it should be under docs can you move it Content is primarily for blogs

Actually, this is correct: Docs are moved during build into content, that's why we have /docs outside /content/. Here we are also generating the cli-docs and put them to content at runtime.

@OrlinVasilev
Copy link
Member

Why so complicated? why not to create them directly in the tree? or to import the repository ?

Signed-off-by: ALTHAF <[email protected]>
@Vad1mo
Copy link
Member

Vad1mo commented Oct 22, 2024

Why so complicated? why not to create them directly in the tree? or to import the repository ?

this is how the project does the docs, and I think having the md. files imported is not so bad.
On the other hand, your idea of simplicity sounds intriguing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants