docs(contribute): add documentation contribution
parent
7348e9ca17
commit
a07e1b342c
|
@ -45,14 +45,28 @@ Access Portainer at `http://localhost:9000 <http://localhost:9000>`_
|
|||
.. TIP::
|
||||
The frontend application will be updated when you save your changes to any of the sources (:file:`app/**/*.js`, :file:`assets/css/app.css` or :file:`index.html`). Just refresh the browser.
|
||||
|
||||
.. IMPORTANT::
|
||||
Do not forget to `lint <http://www.javascriptlint.com/>`_ your code:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ yarn grunt lint
|
||||
|
||||
Contribution guidelines
|
||||
=======================
|
||||
|
||||
Please follow the contribution guidelines on `the repository <https://github.com/portainer/portainer/blob/develop/CONTRIBUTING.md>`_.
|
||||
|
||||
|
||||
Contributing to the documentation
|
||||
=================================
|
||||
|
||||
Checkout the project and go inside the root directory:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ git clone https://github.com/portainer/portainer-docs.git
|
||||
$ cd portainer-docs
|
||||
|
||||
|
||||
Update the documentation and trigger a local build:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ docker run --rm -v ${PWD}/docs:/src portainer/docbuilder:latest make html
|
||||
|
||||
This will create a local folder :file:`docs/build/html` where you will find the generated static files for the documentation.
|
||||
|
|
Loading…
Reference in New Issue