matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

#117 part 1: New documentation website (#151)

Browse Source 
This commit concerns the first subtask of this issue: https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117

It provide a brand new documentation website, that replace the previous markdown files.
The website is auto-generated using CI/CD, and can be found here: https://johnxlivingston.github.io/peertube-plugin-livechat/
This commit is contained in:
John Livingston
2023-02-13 17:58:06 +01:00
committed by GitHub
parent dc1de61a95
commit e17257a90f
114 changed files with 2302 additions and 990 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
support/documentation/content/contributing/document/_index.en.md Normal file
View File

@ -0,0 +1,51 @@
+++
title="Document"
description="Documenter the plugin, or translate the documentation."
weight=50
chapter=false
+++
## General informatiosn
Always inform the community before working (by creating a new issue, or commenting an existing one). This is to avoid that two persons are
working on the same thing, and prevent conflicts.
Please use the `develop` branch. The `main` branch is reserved to released versions of the plugin, so that the documentation is always synchronized with the released version of the plugin.
The documentation source code is in the `support/documentation/content` folder.
The documentation is generated using [Hugo](https://gohugo.io/).
You have to install it on your computer if you want to preview your work.
The used theme is [hugo-theme-learn](https://learn.netlify.app/).
You should read its documentation before starting editing the documentation.
## Translations
The principal language is english (`en` code).
The different translations of the same file are side by side in the
tree, and are identified by a language code in the file name extension.
Example: `_index.fr.md` is the French translation of `_index.en.md`.
Please note that a missing translation file will not appear in the menus of the generated site.
**Always make sure to create files for all languages**, even if the translation is not yet available.
For this, there is a script `doc-generate-missing-translations.sh` in the root of the repository. When you add a new file, you just have to create the english version, then run this script. It will create all missing translations, putting a sample message inviting the user to read the english version.
## Preview
To preview your modifications, just run:
```bash
hugo serve -s support/documentation/
```
Then open your browser on the address
[http://localhost:1313/peertube-plugin-livechat/](http://localhost:1313/peertube-plugin-livechat/).
This page will automatically refresh on each modification.
## Publication
Publishing the documentation is automatic, as soon as the changes are merged into the `main' branch.