mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-13 16:43:22 +00:00
Billy Tat
53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
Rancher Docs
|
|
------------
|
|
|
|
## Contributing
|
|
|
|
We have transitioned to versioned documentation for Rancher (files within `content/rancher`).
|
|
|
|
New contributions should be made to the applicable versioned directories (e.g. `content/rancher/v2.5` and `content/rancher/v2.0-v2.4`).
|
|
|
|
Contents under the `content/rancher/v2.x` directory are no longer maintained after v2.5.6.
|
|
|
|
## Running for development/editing
|
|
|
|
The `rancher/docs:dev` docker image runs a live-updating server. To run on your workstation, run:
|
|
|
|
Linux
|
|
```bash
|
|
./scripts/dev
|
|
```
|
|
|
|
Windows
|
|
```powershell
|
|
./scripts/dev-windows.ps1
|
|
```
|
|
|
|
and then navigate to http://localhost:9001/. You can customize the port by passing it as an argument:
|
|
|
|
Linux
|
|
```bash
|
|
./scripts/dev 8080
|
|
```
|
|
|
|
Windows
|
|
```powershell
|
|
./scripts/dev-windows.ps1 -port 8080
|
|
```
|
|
|
|
License
|
|
=======
|
|
Copyright (c) 2014-2019 [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.
|