|
| 1 | +# Contribute to phpBB Documentation |
| 2 | + |
| 3 | +Do you have an improvement, bug fix or translation for our Docs? |
| 4 | + |
| 5 | +## Contents: |
| 6 | +1. [Fork and Clone](#fork-and-clone) |
| 7 | +2. [Create a Branch](#create-a-branch) |
| 8 | +3. [Submit a Pull Request](#submit-a-pull-request) |
| 9 | +4. [Build Development Docs](#build-development-docs) |
| 10 | + |
| 11 | +## Fork and Clone |
| 12 | + |
| 13 | +1. On GitHub, create a fork of `phpbb/documentation` to your GitHub account. |
| 14 | + |
| 15 | +2. Create a local clone of your fork: |
| 16 | +```shell |
| 17 | +$ git clone git://github.com/YOUR_GITHUB_NAME/documentation.git |
| 18 | +``` |
| 19 | + |
| 20 | +## Create a Branch |
| 21 | + |
| 22 | +1. Create a new branch in your repository before doing any work. It should be based off the branch you intend to update: |
| 23 | +```shell |
| 24 | +$ git checkout -b myNewbranch origin/master |
| 25 | +``` |
| 26 | + |
| 27 | +2. Do work on your branch, commit your changes and push it to your repository: |
| 28 | +```shell |
| 29 | +$ git commit -a -m "My new feature or bug fixes" |
| 30 | +$ git push origin myNewbranch |
| 31 | +``` |
| 32 | + |
| 33 | +## Submit a Pull Request |
| 34 | + |
| 35 | +1. Go to your repository on GitHub.com. |
| 36 | + |
| 37 | +2. Click the Pull Request button. |
| 38 | + |
| 39 | +3. Make sure the correct branch is selected in the base branch dropdown menu. |
| 40 | + |
| 41 | +## Build Development Docs |
| 42 | + |
| 43 | +You can build our Development Docs in your local environment to make it easier when writing new or updated |
| 44 | +documentation. The following steps may vary slightly depending on your OS, so if you run into any trouble you may |
| 45 | +ask for guidance in our [Discord or IRC Channels](https://www.phpbb.com/support/chat/). |
| 46 | + |
| 47 | +1. Make sure you have Python3 installed (you can check by running `$ python -V`) |
| 48 | + |
| 49 | +2. Make sure your have PIP installed (you can check by running `$ pip -V`) |
| 50 | + |
| 51 | +3. Install [Sphinx Docs](https://www.sphinx-doc.org/en/master/usage/installation.html): |
| 52 | + ```shell |
| 53 | + $ pip install -U sphinx |
| 54 | + ``` |
| 55 | + |
| 56 | +4. Verify Sphinx installed: |
| 57 | + ```shell |
| 58 | + $ sphinx-build --version |
| 59 | + ``` |
| 60 | + > You may need to set a shell $PATH variable to point to wherever your Sphinx binaries were installed in your system |
| 61 | + |
| 62 | +5. Install all the dependencies needed for our Docs: |
| 63 | + ```shell |
| 64 | + $ pip install sphinx_rtd_theme |
| 65 | + $ pip install sphinxcontrib-phpdomain |
| 66 | + $ pip install sphinx-multiversion |
| 67 | + $ sudo pip install git+https://github.com/marc1706/sphinx-php.git |
| 68 | + ``` |
| 69 | + |
| 70 | +6. Build the Docs |
| 71 | + ```shell |
| 72 | + $ cd development |
| 73 | + $ make html |
| 74 | + ``` |
| 75 | + |
| 76 | +7. You can now view the Docs by pointing a browser to `development/_build/html/index.html` |
0 commit comments