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

Docs/tutorials registry #606

Merged
merged 2 commits into from
Apr 28, 2021
Merged

Docs/tutorials registry #606

merged 2 commits into from
Apr 28, 2021

Conversation

holyhope
Copy link
Collaborator

No description provided.

@steven-zou
Copy link
Collaborator

@holyhope

md doc lint failed.

I saw you removed the external DB, Redis, and storage configuration doc links, will you add them in other sections?

@holyhope
Copy link
Collaborator Author

It is not yet planed. I saw that:

  • This documentation was outdated and was here because CRD were not strongly typed.
  • CRD documentation explains well all storage definitions.
  • The documentation I removed did not bring anything more than the CRD documentation.

Do not you agree?

Spec customization are well defined in docs/CRD/custom-resource-definition.md

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

It is not yet planed. I saw that:

  • This documentation was outdated and was here because CRD were not strongly typed.
  • CRD documentation explains well all storage definitions.
  • The documentation I removed did not bring anything more than the CRD documentation.

Do not you agree?

@holyhope

Ok, I got your plan. I agree. For better doc navigation experiences, I can create some doc links to point to the right section of the CRD spec doc for guiding users on how to customize the external services.

One more thing, maybe we also need to add comments on the CRD about the secret data of psql secret and redis secret?

Copy link
Collaborator

@steven-zou steven-zou left a comment

Choose a reason for hiding this comment

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

LGTM

@steven-zou steven-zou merged commit e5e4d2f into goharbor:master Apr 28, 2021
@steven-zou
Copy link
Collaborator

It is not yet planed. I saw that:

  • This documentation was outdated and was here because CRD were not strongly typed.
  • CRD documentation explains well all storage definitions.
  • The documentation I removed did not bring anything more than the CRD documentation.

Do not you agree?

@holyhope

Ok, I got your plan. I agree. For better doc navigation experiences, I can create some doc links to point to the right section of the CRD spec doc for guiding users on how to customize the external services.

One more thing, maybe we also need to add comments on the CRD about the secret data of psql secret and redis secret?
@holyhope

I’ll merge this PR and append some info about the data of psql secret and redis secret as well as related links pointing to the right content sections located at CRD spec doc.

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.

None yet

3 participants