goharbor / goharbor/harbor-cli

[discussion]: Addition of Harbor CLI Side Documentation

Open
#755 3 comments 0 reactions 0 assignees View on GitHub
discussion
Dominant language
Go
Stars
163
Forks
211
Avg merge
1m
Merged PRs (30d)
1

Description

## Topic
For Harbor CLI to move out of Sandbox into Incubation, a major part of it is the addition of documentation to the Harbor Organization Docs.
A problem that occurs with this is that Harbor uses Hugo, which builds static files which cannot be change, Harbor releases happen approximately bi-annually.

To accomodate this, I suggest keeping a CLI-side documentation, not as grand, but up-to-date. So even when our releases are weekly/monthly users can have an updated documentation. Instead of the outdated one that harbor keeps.

And we can just add a tag/mention, on the harbor docs saying, Hey, for more up-to-date docs, have a look at

@bupd @Vad1mo @qcserestipy would appreciate your thoughts

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.