63861a7fee
* docs/Release_Board-Maintainers.md: Maintain consistent formatting
- Name in upper table should be GitHub (not forum) handle.
- Using '"' on following line, instead of repeating the board name.
* docs/Release_Board-Maintainers.md: Add ZazaBr GitHub handle
* docs/Release_Board-Maintainers.md: Add Kalobok GitHub handle
Because this was the last person we were looking for their GitHub
handle, I removed references to contact me about that.
* docs/Release_Board-Maintainers.md: Repeat board names instead of "
Reversing my earlier policy (of putting a double quote ('"') for
additional lines of Maintainer(s)), as I realized the table will be
easier to (re-)sort this way.
* docs/Release_Board-Maintainers.md: Add # column + instructions
This is for easier table maintenance, and differentiation between
primary and secondary maintainers.
I finally realized we will just need to add a '#' column if we want to
be able to easily sort this table.
I also added some (hopefully simple) instructions. As I was not sure
of anywhere else better to put them.
Finally, I was able to easily sort (by lines) the new table,
incorporating some additions at the bottom which previously had been
out of order.
* docs/Release_Board-Maintainers.md: Move sections around
- Move 'Maintaining this document' section to bottom.
- Create 'Table of Board Maintainers' heading.
- Move some other things around as appropriate.
Armbian Documentation
Overview
Documentation is written in markdown and stored in the docs/ subfolder. Images go in docs/images.
This repo is meant for storing and quick glances. Official output is https://docs.armbian.com.
Armbian Documentation is available in the following formats:
Contributing
This site is built with mkdocs and depends on mkdocs-material.
Armbian Documentation naming of document files follows this rules:
[Parent-Topic-Example]_[Child-Topic]-example.md
Parent-Topic-Name and Child-Topic-Name are separated by an underscore _. Hyphens - are automatically converted to space.
Please try to avoid creating new parent topics unless absolutely necessary.
Current Parent Topics:
- User Guide
- Hardware notes
- Developer Guide
- Contributor Process
- Release management
- Community
See the document template before you writing any content.
Working on the content
git clone https://github.com/armbian/documentation
pip install -r requirements.txt
mkdocs build --clean && mkdocs serve
You will be able to make edits to existing files and observe the results in real time.
After changing text in an existing file, use this command to rebuild and view the documentation:
mkdocs build --clean && mkdocs serve
After adding a new file, either hand-edit mkdocs.yml, or re-run tools/mkArmbianDocs.py unless making changes to the structure of the docs/ folder. (See below)
Generate tools
mkArmbianDocs.py
Generate mkdocs.yml based on the contents of docs/ folder
- Command-line options for input and output directories
- Requires install requirement
- You don't need to run it every time unless making changes to the structure of the
docs/folder - See
mkArmbianDocs.py -hfor help
From the parent folder of the repo, run:
python3 tools/mkArmbianDocs.py && mkdocs build
This will generate the mkdocs.yml and publish built HTML to the site/ folder.