mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-04-15 10:55:37 +00:00
a7c4d606ee
* Added page about moving/renaming docs, new headings for readme * added navigation section * revised README * revised moving-or-renaming-docs * Apply suggestions from code review Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update moving-or-renaming-docs.md - revamping schema example * json > js * typos, extra explanation * json > js * various changes --------- Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
97 lines
4.6 KiB
Markdown
97 lines
4.6 KiB
Markdown
# Contribute to Rancher Docs
|
|
|
|
Welcome to the [Rancher docs](https://ranchermanager.docs.rancher.com/) repository. See the [Rancher software](https://github.com/rancher/rancher) repository if you have questions or requests for the Rancher platform.
|
|
|
|
## Make a Suggestion
|
|
|
|
You can suggest changes to the Rancher docs in two ways:
|
|
|
|
1. [Open an issue](https://github.com/rancher/rancher-docs/issues/new/choose).
|
|
1. Edit the docs in the way you see fit and open a pull request.
|
|
|
|
## Edit the Docs
|
|
|
|
To get started, [fork](https://github.com/rancher/rancher-docs/fork) and clone the rancher-docs repository.
|
|
|
|
Our repository doesn't allow you to make changes directly to the `main` branch. Create a working branch and make pull requests from your fork to [rancher/rancher-docs](https://github.com/rancher/rancher-docs).
|
|
|
|
For most updates, you'll need to edit a file in `/docs`, and the corresponding file in `/versioned_docs/version-2.7`. If a change affects older versions, you can find files documenting Rancher v2.0 and later in the `/versioned_docs` directory.
|
|
|
|
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](./moving-or-renaming-docs.md).
|
|
|
|
### Navigate the Repo
|
|
|
|
The file paths in the repo correspond to the URLs for pages on the docs website. The docs for the latest version of Rancher 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. Older docs are found within `/versioned_docs` and generally follow the same structure as the files in `/docs`.
|
|
|
|
### Style & Formatting
|
|
|
|
The docs are written in [Markdown](https://www.markdownguide.org/getting-started/). We refer to the Microsoft [style guide](https://learn.microsoft.com/en-us/style-guide/welcome/) and use standard American English. Many pages are also available in Simplified Chinese.
|
|
|
|
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.
|
|
|
|
## Run the Docs Website
|
|
|
|
The Rancher Docs website is built with [Docusaurus 2](https://docusaurus.io/), 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:
|
|
|
|
1. If you haven't already, install [Node](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/getting-started/install).
|
|
1. Go into your local rancher-docs folder.
|
|
1. The Rancher Docs repository already contains a yarn.lock file, which contains the dependencies you need to build the website. Run `yarn` to install Docusaurus and associated dependencies.
|
|
|
|
### Start Site
|
|
|
|
```
|
|
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`.
|
|
|
|
### Build Site
|
|
|
|
```
|
|
yarn build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
### Launch With Docker
|
|
|
|
You can also use [Docker](https://www.docker.com/) 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.
|
|
|
|
License
|
|
=======
|
|
Copyright (c) 2014-2023 [Rancher Labs, Inc.](https://rancher.com)
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|