github.com/pachyderm/pachyderm@v1.13.4/doc/README.md (about)

     1  # Pachyderm Documentation
     2  
     3  These docs are rendered and searchable in our [Documentation Portal](https://docs.pachyderm.com). Here are a few section links for quick access:
     4  
     5  - [Getting Started](https://docs.pachyderm.com/latest/getting_started/) — includes local installation and Beginner Tutorial.
     6  - [Concepts](https://docs.pachyderm.com/latest/concepts/) — provides an overview of the main Pachyderm concepts.
     7  - [How-Tos](https://docs.pachyderm.com/latest/how-tos/) — includes how-tos about that describe how you can load your data into Pachyderm, export it to external systems, split your data, and all the other data operaions and features available in Pachyderm. 
     8  - [Pachctl API Documentation](https://deploy-preview-4312--pachyderm-docs.netlify.com/latest/reference/pachctl/pachctl/) — provides an overview of all Pachyderm CLI tool commands.
     9  
    10  Have more questions? — Join our [Slack channel](http://slack.pachyderm.io/).
    11  
    12  # Can I Contribute to Docs?
    13  
    14  Absolutely! We welcome external contributors!  
    15  Before sending a PR, please read our [Documentation Style Guide](https://docs.pachyderm.com/latest/contributing/docs-style-guide/).
    16  
    17  
    18  # New to Pachyderm's documentation but want to contribute? Set up your Doc development environment.
    19  
    20  Our documentation is built on **mkdocs** and runs on **Netlify**. All content is created in markdowm (.md) language.
    21  
    22  ## 1- Directory structure
    23  Root directory: ```pachyderm/doc```
    24  We are maintaining several versions of the documentation in:
    25  ```shell
    26      - doc
    27          |- docs
    28              |- 1.10.x
    29              |- 1.11.x
    30              |- master
    31  ```
    32  *Note: the **master** version is the future release.*
    33  Each version comes with its own configuration (navigation) file:
    34  
    35  ```shell
    36       - doc
    37          |- mkdocs-1.10.x.yml
    38          |- mkdocs-1.11.x.yml
    39          |- mkdocs-master.yml
    40  ```
    41  
    42  ## 2- Run the Documentation locally
    43  ### 2.0- Prerequisite
    44  [Docker install](https://docs.docker.com/get-docker/)
    45  
    46  ### 2.1- Run a *given version* of the documentation locally with hot-reload
    47  This is especially useful in DEV mode (i.e., you are actively writing or editing content on a given version). 
    48  You do not need to understand the inner workings of mkdocs or Netlify. 
    49  You will be able to edit your version of the documentation and immediately check out the outcome on your local browser. 
    50  
    51  Follow those 4 steps:
    52  
    53  1. Choose the .yml of the doc version you want to consider (Default to mkdocs-1.11.x.yml) and update `doc/docker-compose.yml` accordingly (in 'command' section).
    54  
    55  2. Build your Docker image (~10 min). In the `doc` directory, run:
    56      ```shell
    57          DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose build mkdocs-serve
    58      ```
    59  3. Then, run: 
    60      ```shell
    61          docker-compose up mkdocs-serve
    62      ```
    63  4. Check your local server in your preferred browser.
    64      ```shell
    65          0.0.0.0:8889
    66      ```
    67  Your source code is now visible from the container allowing a hot reload.
    68  
    69  ### 2.2- Run the full doc website (all versions)
    70  Especially useful if you want to have a last look at your final product before committing your work. It will be as close as the production as can be.
    71  1. Build your Docker image (~10 min). In the `doc` directory, run:
    72      ```shell
    73          DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose build netlify-dev
    74      ```
    75  2. In the doc directory, run: 
    76      ```shell
    77          docker-compose up netlify-dev
    78      ```
    79  3. Check your local server in your preferred browser.
    80      ```shell
    81          0.0.0.0:8888
    82      ```