New documentation
We build documentation and host it in Read the Docs.
All documentation files are stored only in gh-pages
branch, with the following directory structure:
docs
├── _config.yml
├── devel-docs
├── docs
└── index.rst
Documentation is created using reStructuredText , is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system.
Procedure
Consider the editing style of existing pages.
Edit a doc page or create a new one in
gh-pages
branch.Insert in
index.rst
according to the section.
Note
Documentation web is updated automatically, thanks to Read the Docs.
Convert POD files
Install libpod-pom-view-restructured-perl
in your computer.
Step-by-step contributing to docs
So you want to contribute a documentation fix or new entry. Follow these 10 steps carefully.
Create a git account at GitHub.com if you don’t already have one.
Go to the Ravada github repository.
Create your own project copy clicking the
fork
button at the top right of the pageConfigure your git account in your PC:
git config --global user.email "user@domain.com" git config --global user.name "Your real name"
Download your copy
git clone https://github.com/YOUR_GITHUB_ACCOUNT/ravada
Change to the github pages branch:
cd ravada ; git checkout gh-pages
Edit the file inside the
docs/docs/
directoryIf it is a new file run
git add new_file.rst
Commit changes. It will ask for a one line description:
git commit -a
Send the changes to github:
git push
Go to GitHub.com and do a
Pull Request
. Make sure it is from the gh-pages branch
