Skip to content

Harbor-CLI Documentation#580

Closed
Althaf66 wants to merge 3 commits into
goharbor:mainfrom
Althaf66:doc-harborcli
Closed

Harbor-CLI Documentation#580
Althaf66 wants to merge 3 commits into
goharbor:mainfrom
Althaf66:doc-harborcli

Conversation

@Althaf66

Copy link
Copy Markdown
Contributor

Created documentation for Harbor CLI.

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

image

Signed-off-by: ALTHAF <althafasharaf02@gmail.com>
@Vad1mo

Vad1mo commented Oct 12, 2024

Copy link
Copy Markdown
Member

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 <althafasharaf02@gmail.com>
@Althaf66

Copy link
Copy Markdown
Contributor 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
Copy Markdown
Member

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

@Vad1mo Vad1mo left a comment

Copy link
Copy Markdown
Member

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

Vad1mo commented Oct 15, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
Member

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

Signed-off-by: ALTHAF <althafasharaf02@gmail.com>
@Vad1mo

Vad1mo commented Oct 22, 2024

Copy link
Copy Markdown
Member

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