Welcome to the CloudMyDC docs repository. See the CloudMyDC software repository if you have questions or requests for the CloudMyDC platform.
You can suggest changes to the CloudMyDC docs in two ways:
To get started, fork and clone the cloudmydc-docs repository.
Our repository doesn't allow you to make changes directly to the master
branch. Create a working branch and make pull
requests from your fork to Onemind-Services-LLC/cloudmydc-docs.
For most updates, you'll need to edit a file in /docs
.
If a file is moved or renamed, you'll also need to edit the sidebars.js
files for each version, and the list of
redirects in docusaurus.config.js
. See Moving or Renaming Docs.
The file paths in the repo correspond to the URLs for pages on the docs website. The docs for the latest version of
CloudMyDC are located in /docs
. Most index pages are found within the /pages-for-subheaders
directory in /docs
.
All images are in /static/img
in the top level of the repo.
The docs are written in Markdown. We refer to the Microsoft style guide and use standard American English.
Every docs page contain metadata in the first few lines:
---
title: Some Title
---
The title
is rendered as the page's headline. The site renderer wraps the title
value in H1
tags, which are
equivalent to #
in Markdown syntax. This means that all subsequent headers on the page should be second level
(##
) or more.
The CloudMyDC Docs website is built with Docusaurus 2, a modern static website generator.
You can run the site on your local machine, to preview how pages on your working branch will look live.
First, install Docusaurus 2:
yarn
to install Docusaurus and associated dependencies.yarn start
This command starts a local development server for Docusaurus 2, and opens up a browser window. Most changes are reflected live without having to restart the server.
Note: The yarn start
command won't include some important static site features. For example, switching between
languages from the site's dropdown menu is not available. If you need these features, use yarn build
.
yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
You can also use Docker to launch the website.
The below command can be used to install the dependencies and run the site inside a container:
docker run --rm -it -v $PWD:$PWD -w $PWD -p 3000:3000 node:18 /bin/sh -c "yarn install && yarn start -h 0.0.0.0"
Subsequent executions will check for updated dependencies, if there are none, it will skip the updates and quickly start the server.