loft-sh / vcluster-docs

https://vcluster.com/docs
Apache License 2.0
5 stars 26 forks source link

refactor: add versions & multi-instance docusaurus #121

Closed FabianKramm closed 5 months ago

FabianKramm commented 5 months ago

Fixes DOC-69

Changes

Deploy preview https://deploy-preview-121--vcluster-docs-site.netlify.app/docs/

netlify[bot] commented 5 months ago

Deploy Preview for vcluster-docs-site ready!

Name Link
Latest commit 21832d3f8a9b7a2d0132b8a339bf01c0c2f67549
Latest deploy log https://app.netlify.com/sites/vcluster-docs-site/deploys/664f05a31a41ce000846bb83
Deploy Preview https://deploy-preview-121--vcluster-docs-site.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

aimeeu commented 5 months ago

This is failing due to a lot of broken markdown links (npm run build). I checked out the PR and am working on fixing the links.

aimeeu commented 5 months ago
david-loft commented 5 months ago

Overall I like this structure a lot.

Get Started "Get Started" section should be on the 1st level along with "What are virtual clusters" to act as a quick starting point. I understand it will be duplicated inside the vCluster section but currently "What are virtual clusters?" is also duplicated that way and it seems fine.

If the above change is made, also add a prominent link to the vcluster.yaml section at the end of "Get Started" page

Return to Overview "Return to Overview" should have a different style, otherwise it gets lost and currently no easy way to go back to the overview.

In addition to the above, and as a quick improvement to the above point, make the vCluster logo direct to the docs Overview instead of the marketing website. This is standard on docs as a quick way to get to the homepage. There's already a "Website" link on the top header.

Platform/What is vCluster Platform Remove vCluster Pro features like Embedded etcd, Sync patches, etc.

aimeeu commented 5 months ago

Get Started "Get Started" section should be on the 1st level along with "What are virtual clusters" to act as a quick starting point. I understand it will be duplicated inside the vCluster section but currently "What are virtual clusters?" is also duplicated that way and it seems fine.

I moved Get Started to the vCluster section because Get Started contains links to pages int the vCluster section as well as partials. Docusaurus has limitations.

  1. We can't use relative links between docs sets. Overview, vcluster, and platform are all different docs sets. To link to content in a different docs set, we have to use a full URL link not a relative file link.
  2. Partials must live in the docs set that uses them, especially since the partial/fragment is versioned with the docs set.

Also, there are no plans to version the "Overview" landing page. One option would be to make docs site landing page (Overview section) a brief overview of the 2 products rather than repeating the "What are virtual clusters" content.