/portainer-docs

Portainer documentation

Portainer Admin Guides and Documentation

This repository contains the Portainer v1.x, v2.0 and futures versions documentation.

Contributing

We welcome and encourage community contributions. For information about contributing to the Portainer documentation, see Contribution guidelines.

The issues of this repo is the place to manage our To Do. We encourage you to see what has to be done, take a task and contribute.

Running the docs locally

  1. Clone this repository to your local machine.

  2. Install Mkdocs

    The Portainer Documentation uses MkDocs. MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Install MkDocs using the following installation guide

  3. Install Material Theme

    pip install mkdocs-material

  4. Start MkDocs Server

    Multiple sites are hosted in this repository, if you are contributing for v2.0, navigate to the folder v2.0 and start MkDocs Server running:

    mkdocs serve