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

doc(README): refresh the doc structure #543

Merged
merged 9 commits into from
Apr 19, 2021

Conversation

steven-zou
Copy link
Collaborator

  • update README
  • update MAINTAINER
  • create placeholder MD files
  • move MD files to the right places

fix #215

Signed-off-by: Steven Zou szou@vmware.com

- update README
- update MAINTAINER
- create placeholder MD files
- move MD files to the right places

fix goharbor#215

Signed-off-by: Steven Zou <szou@vmware.com>
@steven-zou
Copy link
Collaborator Author

@holyhope

Refreshed the README doc structure, please take a look?

notes: some of the linked docs are just placeholders.

- add doc for describing the CRD spec configuration
- add doc for how customize images pulled by Harbor operator

Signed-off-by: Steven Zou <szou@vmware.com>
@steven-zou steven-zou marked this pull request as draft April 14, 2021 02:53
- describe day1 functions
- mention day2 functions

Signed-off-by: Steven Zou <szou@vmware.com>
@holyhope
Copy link
Collaborator

I am on it 👍

Signed-off-by: Pierre Péronnet <pierre.peronnet@ovhcloud.com>
Signed-off-by: Pierre Péronnet <pierre.peronnet@ovhcloud.com>
Signed-off-by: Pierre Péronnet <pierre.peronnet@ovhcloud.com>
Copy link
Collaborator

@holyhope holyhope left a comment

Choose a reason for hiding this comment

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

I reworked some documentation about the control loop :-)
Can you review it please?


Versions of the underlying components are listed below:

| Components | Harbor | MinIO operator | PostgreSQL operator | Redis operator |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I suggest to move operators in the compatibility section.
Is there any code that install the MinIO operator v4.0.6?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yeah, a kustomization under manifests/cluster

- add docs for kinds of installation ways
- add doc to introduce useful Makefile targets
- fill in doc for introducing the manifests references

Signed-off-by: Steven Zou <szou@vmware.com>
Signed-off-by: Steven Zou <szou@vmware.com>
@steven-zou steven-zou marked this pull request as ready for review April 16, 2021 11:31
@steven-zou
Copy link
Collaborator Author

This PR accumulated too many commits now. Let's merge it now and continue to refine and create docs with other new PRs.

cc @holyhope @heww @bitsf

@steven-zou steven-zou force-pushed the doc/refresh_docs branch 4 times, most recently from 6f737ae to 6dd2658 Compare April 18, 2021 04:20
Signed-off-by: Steven Zou <szou@vmware.com>
@steven-zou steven-zou merged commit d07de09 into goharbor:master Apr 19, 2021
@steven-zou steven-zou deleted the doc/refresh_docs branch April 19, 2021 02:29
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.

Reorganize the documents content (including README) to reflect the latest changes
4 participants