vyos-documentation/CONTRIBUTING.md

Contributor's Guide

1. fork the project on GitHub https://github.com/vyos/vyos-documentation

2. clone the fork to your local machine

   $ git clone https://github.com/YOUR_USERNAME/vyos-documentation
   

3. cd to your new local directory vyos-documentation

4. create a a new branch for your work. You can use a name that describes what you do.

   $ git checkout -b fix-vxlan-typo
   

5. make your changes.

   Please check the documentation if you aren't familiar with sphinx-doc or reStructuredText

   Note the following RFCs, which describe the reserved public IP addresses and autonomous system numbers for the documentation. RFC5737, RFC3849, RFC5389, RFC7042

   • 192.0.2.0/24
   • 198.51.100.0/24
   • 203.0.113.0/24
   • 2001:db8::/32
   • 16bit ASN: 64496 - 64511
   • 32bit ASN: 65536 - 65551
   • Unicast MAC Addresses: 00-53-00 to 00-53-FF
   • Multicast MAC-Addresses: 90-10-00 to 90-10-FF

Please don't use other public address space.

6. Check your changes by locally building the documentation

   $ cd docs
   $ make html
   

   Sphinx will build the html files in the docs/_build folder

7. add the modified files

   $ git add path/to/filname
   

   or add all unstaged files

   $ git add .
   

8. commit your changes

   $ git commit -m "rename vxlan set syntax"
   

9. push your commits to your GitHub project:

   $ git push -u origin fix-vxlan-typo
   

10. submit a pull request.

    In GitHub, visit the main repository and you should see a banner suggesting to make a pull request. Fill out the form and describe what you do.

11. once pull resquests have been approved, you may want to locally update your forked repository too. First you'll have to add the remote upstream repository.

    $ git remote add upstream https://github.com/vyos/vyos-documentation.git
    

    Check your configured remote repositories.

    $ git remote -v
    origin    https://github.com/YOUR_USERNAME/vyos-documentation.git (fetch)
    origin    https://github.com/YOUR_USERNAME/vyos.documentation.git (push)
    upstream  https://github.com/vyos/vyos-documentation.git (fetch)
    upstream  https://github.com/vyos/vyos-documentation.git (push)
    

    Your remote repo on Github is called Origin, while the original repo you have forked is called Upstream.

    Now you can locally update your forked repo.

    $ git fetch upstream
    $ git checkout master
    $ git merge upstream/master
    

    If you want to update your fork on Github too:

    $ git push origin master