Testing documentation builder

Copyright 2020 go2scale

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# 🦊 Pages

## Description

Publish HTML documentation located in `public` folder, retrieved as an artifact

from previous job named `documentation`.

## How to use it

!!! note "Requirements"

    You have to use a job which build your documentation in a previous stage.

    We recommend you to use a documentation job available on the HUB in [build

    📦 stage](/jobs/#build). They build documentation and publish it as

    artifact in `documentation_build/` folder.

    **Documentation jobs list:**

    * [ApiDoc](/jobs/build/apidoc/)

    * [Mkdocs](/jobs/build/mkdocs/)

1. Choose a version in [version list](#versions)

3. Add the corresponding URL to your `.gitlab-ci.yml` file (see [Getting

   started](/getting-started)). Example:

    ```yaml

    include:

      - remote: 'https://jobs.go2scale.io/pages.yml'

    ```

4. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/getting-started/#jobs-customization)

5. Well done, your job is ready to work ! 😀

## Job details

* Job name: `pages`

* Docker image: [`ruby`](https://hub.docker.com/_/ruby)

* Stage: `deployment`

* When: only run on `master` branch

| Name | Description | Default |

| ---- | ----------- | ------- |

| `PAGES_BUILD_PATH` | Path to folder which contains documentation build | `documentation_build/` |

name: pages

description: A ready-to-use gitlab pages job to deploy your static pages from gitlab

default_stage: deployment

icon: 🦊

 No newline at end of file

* **Tag `2020-08-05_1`** : `https://jobs.go2scale.io/2020-08-05_1/pages.yml`

    * Initial version

 No newline at end of file

* **Tag `2020-08-09_1`** : `https://jobs.go2scale.io/2020-08-09_1/pages.yml`

    * Add possibility to retrieve build artifact from any job in previous stage

    * Add variable `PAGES_BUILD_PATH` to indicate the location of build to

      deploy

    * Return error case when there is nothing to deploy

 No newline at end of file