Add documentation for Harbor CLI configuration and encryption management - #645
Conversation
Signed-off-by: ALTHAF <althafasharaf02@gmail.com>
Signed-off-by: ALTHAF <althafasharaf02@gmail.com>
Signed-off-by: ALTHAF <althafasharaf02@gmail.com>
Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
…nt, added section for encryption management Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
… docs Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
709fa5b to
14abb82
Compare
|
The origin of this is this PR in the CLI: goharbor/harbor-cli#390 |
|
As this is my first time continuing another contributor's work in a public project, I want to ensure proper credit attribution for @Althaf66's original contributions. Please confirm commit authorship appears correctly in the branch history and verify the original contribution chain is properly referenced. Let me know if any attribution adjustments are needed. |
bupd
left a comment
There was a problem hiding this comment.
Thanks for the contribution
I have suggested some changes
…cli; updated script to use rsync for keeping files in sync and removing outdated docs. encryption, config and main index docs have been moved to cli repo Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
|
@bupd, I have incorporated all of your changes and moved the encryption and config docs to the harbor-cli repo in this PR. Since the |
Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>
|
@qcserestipy Mayve it would make sense to inject into the top page the tag version this documentation refers too? Here on the top down in the bottom...
|
…ent (goharbor#645) * modified readme file Signed-off-by: ALTHAF <althafasharaf02@gmail.com> * deleted md files Signed-off-by: ALTHAF <althafasharaf02@gmail.com> * Added Documentation for Harbor-CLI Signed-off-by: ALTHAF <althafasharaf02@gmail.com> * Cherry pick finished Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Added more cli docs entries, added section for configuration management, added section for encryption management Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Added cross reference between encryption and configuration management docs Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Fix: typo Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Updated cli-docs generation script to track the latest tag of harbor-cli; updated script to use rsync for keeping files in sync and removing outdated docs. encryption, config and main index docs have been moved to cli repo Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Added latest tag after release of harbor-cli Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Clean up Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * Try add ranges to fix sorting in cli-docs side bar Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> * add ranges to fix sorting in cli-docs side bar and layout Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> --------- Signed-off-by: ALTHAF <althafasharaf02@gmail.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com> Co-authored-by: ALTHAF <althafasharaf02@gmail.com> Co-authored-by: Prasanth Baskar <bupdprasanth@gmail.com> Signed-off-by: Ross Golder <ross@golder.org>
The content/cli-docs/ directory is generated at build time by cli-docs.sh, similar to content/docs/. It should not be tracked in git. This reverts the accidental tracking added in PR goharbor#645 by untracking the 109 generated files and adding content/cli-docs/ to .gitignore. Signed-off-by: Ross Golder <ross@golder.org>
The content/cli-docs/ directory is generated at build time by cli-docs.sh, similar to content/docs/. It should not be tracked in git. This reverts the accidental tracking added in PR goharbor#645 by untracking the 109 generated files and adding content/cli-docs/ to .gitignore. Signed-off-by: Ross Golder <ross@golder.org>
The content/cli-docs/ directory is generated at build time by cli-docs.sh, similar to content/docs/. It should not be tracked in git. This reverts the accidental tracking added in PR goharbor#645 by untracking the 109 generated files and adding content/cli-docs/ to .gitignore. Signed-off-by: Ross Golder <ross@golder.org>
The content/cli-docs/ directory is generated at build time by cli-docs.sh, similar to content/docs/. It should not be tracked in git. This reverts the accidental tracking added in PR goharbor#645 by untracking the 109 generated files and adding content/cli-docs/ to .gitignore. Signed-off-by: Ross Golder <ross@golder.org>
Same class of breaking change as the docs/ partials: these two templates (added by goharbor#645, after the Hugo upgrade work was originally branched) never got the .File nil-guard that Hugo 0.163 requires. Broke the /cli-docs section outright once content/cli-docs stopped being tracked in git and started coming purely from cli-docs.sh's generated output at build time - the section index page has no .File, and Hugo 0.163 errors instead of Hugo 0.74's more lenient handling. Verified: full `make production-build` succeeds (2150 pages, 0 errors), /cli-docs renders. Signed-off-by: Ross Golder <ross@golder.org>
Same class of breaking change as the docs/ partials: these two templates (added by goharbor#645, after the Hugo upgrade work was originally branched) never got the .File nil-guard that Hugo 0.163 requires. Broke the /cli-docs section outright once content/cli-docs stopped being tracked in git and started coming purely from cli-docs.sh's generated output at build time - the section index page has no .File, and Hugo 0.163 errors instead of Hugo 0.74's more lenient handling. Verified: full `make production-build` succeeds (2150 pages, 0 errors), /cli-docs renders. Signed-off-by: Ross Golder <ross@golder.org>





Add documentation for Harbor CLI configuration and encryption management
Purpose
This PR introduces comprehensive documentation for two critical aspects of Harbor CLI:
Changes
Configuration Management Documentation
--configflag > env var > XDG paths)Encryption Management Documentation
Notes
Let me know if any sections need expansion or clarification!