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

[WIP] refine the website structure #416

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

haoqing0110
Copy link
Member

@haoqing0110 haoqing0110 commented May 30, 2024

More and more fields and operations are added to OCM, like rollout strategy, placement strategy, addon template, manfestworkreplicaset, etc, they are all mixed in the existing "Concept" section. This increases the mental load for OCM beginners, and makes users confused about like, addon vs manifestwork, addon-framework vs addon template.

This PR proposed adding new sections, User guides and FAQs to the OCM website.

  • Concept: focus on what it is and how it works, the relationship between the key concepts. For example, what is ManagedCluster, how to register it to the hub, and how the cert rotates.
  • User guides: what users can do. For example, how to register or uninstall a ManagedCluster.
  • FAQ: frequently asked questions. For example, addon vs manifestwork vs addon vs manifestworkreplicaset, which one should be chosen to use.

If this can be discussed and approved, subsequent PR will be submitted, split the concept and user guide and fulfil the missing content.

Copy link
Contributor

openshift-ci bot commented May 30, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: haoqing0110
Once this PR has been reviewed and has the lgtm label, please assign mprahl for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot
Copy link
Contributor

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants