The documentation is written in markdown, and then converted in two directions to create both this User Guide and the on-line help files that are bundled with the application.
Clone the documentation repository
Make changes locally. Pay close attention to formatting and syntax - use the live reload function (
mkdocs serve) to preview them.
When you’re happy, push the changes to your remote repository and open a pull request
Because we upload the theme as well, what it looks like locally should be 100% representative of what it looks like once it’s pushed to the Internet.
Command sequence (this presumes Linux, but Windows is very similar):
git add -A(presumes to add everything, you can of course be selective)
git commit -m "Summary of changes"
… and then open the PR on github
To update and resync, someone (me, probably!) needs to:
- Merge the changes
- Pull the latest revisions from the repository
- Convert the webui files:
./convert.sh docs/webui <target_directory>
To merge the webui files into tvheadend, copy them into
<your tvheadend clone>/docs/html,
push them to your remote repository and open a PR to merge them into master.
- Convert all files:
mkdocs build --clean
- Copy the contents of the resultant
sitedirectory to gihub pages
To publish the entire User Guide to gihub, use
resync.sh or use the
following command sequence:
cp -r $YOUR_BASE_DIR/tvheadend-documentation/site/* .
git add -A(presumes to add everything)
git commit -m "Resync"(or whatever your commit message is)