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: update homepage content and add diagram #591

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

minaelee
Copy link
Contributor

Improvements including:

  • Add diagram per FE request
  • Expand product description as more than "a collection of services"
  • Remove redundant descriptions of components
  • Move the information on MicroCloud documentation higher
  • Revise/simplify description of how the integration of the docs sets works

@github-actions github-actions bot added the Documentation Documentation needs updating label Jan 25, 2025
@minaelee minaelee force-pushed the update-docs-homepage branch from 264d8f5 to 50c1f98 Compare January 27, 2025 22:30
Copy link
Contributor

@mseralessandri mseralessandri left a comment

Choose a reason for hiding this comment

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

Hi @minaelee thanks! I just left a couple of comments.


```{note}
The MicroCloud documentation set is targeted specifically at users of MicroCloud.
With MicroCloud, you can eliminate the complexity of manual setup and quickly benefit from the advanced features of its components, such as high availability, self-healing clusters, automatic security updates, and fine-grained access control for multi-tenancy. Cluster members can run full virtual machines or lightweight system containers with bare-metal performance.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the concepts are mixed up. High availability, self-healing clusters and fine grained access control are MicroCloud features, whereas the security updates are available through snap refreshes. Fine grained access control is not only for multi-tenency

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the concepts are mixed up. High availability, self-healing clusters and fine grained access control are MicroCloud features, whereas the security updates are available through snap refreshes. Fine grained access control is not only for multi-tenency

Gotcha! I can remove "automatic security updates" and "for multi-tenancy". Is there anything you would like to mention in their place?

For convenience, this site provides not only MicroCloud's documentation but also an integrated view of all four documentation sets. You can easily switch between sets using the links in the site header, allowing you to explore all the related documentation without leaving this site.

```{note}
The components' documentation sets are written for a general audience that might not be using MicroCloud. Thus, not all the information in these sets are relevant to MicroCloud users. For example, since MicroCloud automates the installation of its components, you can ignore the manual installation instructions in the components' documentation.
Copy link
Contributor

Choose a reason for hiding this comment

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

We should revisit this section when when have the tagging feature on not relevant pages

@minaelee minaelee force-pushed the update-docs-homepage branch from 50c1f98 to 0b85631 Compare January 29, 2025 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants