-
fork the project on GitHub https://github.com/vyos/vyos-documentation
-
clone the fork
-
create a a new branch for your work. You can use a name that describes what you do.
git checkout -b fix-vxlan-typo
-
make your changes.
Please check the documation, if you don'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. Please don't use other public address space.
-
add the modified files
git add path/to/filname
or add all unstaged files
git add . -
commit your changes
git commit -m "rename vxlan set syntax" -
push your commits to your GitHub project:
git push -u origin fix-vxlan-typo
-
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.