mirror of
https://github.com/vatesfr/xen-orchestra.git
synced 2026-09-10 22:14:48 -05:00
ab7b2fc7a9
* docs(xo): refine page titles and navigation structure Make page titles clearer and more consistent with their content and purpose. Reorder some pages (and sections) and align their sidebar labels with their titles to make the documentation easier to navigate and understand. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> * docs(sidebars.ts): move discover xo category back to where it was Applying the change suggested by olivierlambert. The 'Discover Xen Orchestra' category now follows the 'Getting started' category. The 'architecture' page/ 'How XO 6 is organized' stays at the end of the Getting Started category. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> * docs(xo): specify navbar titles Applying changes suggested by olivierlambert. Some titles in the navigation bar were made too long, in an attempt to make them identical to the titles in the corresponding doc pages. Having different titles in the navbar and in the actual page is not a defect, and can indeed help readers scan the document structure quicker. As a result, we're (re-)adding sidebar_label metadata to specify a navbar title where the page title was too long. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> * docs(xo): revert individual page renames Applying changes suggested by olivierlambert, following, the reasoning he explained in the pull request. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> * docs(intro_support.md) change title to 'support' Apply change suggested by olivierlambert. 'Support' instead of 'Support options' is shorter and carries the same meaning overall. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> * docs(xo): update outdated internal link labels A few commits ago, some page titles were changed. This did not break any internal links, but it left some link labels outdated. This commit updates those labels to match the current page titles. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> * docs: convert page titles to sentence case Applying changes suggested by olivierlambert Some page titles were still using title case, even though we use sentence case throughout the XO documentation. This commit updates those titles to follow the same convention. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> * docs(xo): switch gerund titles to noun forms Some page titles used gerunds (the -ing form), while others used nouns or noun phrases, resulting in an inconsistent style. This commit changes the gerund titles to noun-based titles for consistency. The "Troubleshooting" title is kept as-is because it is a noun, despite ending in -ing. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech> --------- Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
Website
This website is built using Docusaurus, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.