Skip to content
Snippets Groups Projects
Commit 41d8c5a4 authored by Martyn Welch's avatar Martyn Welch
Browse files

Add layout guidelines to README


Add the expectations for the utilisation of the various existing sections
to the website README.md to help guide contributors.

Signed-off-by: default avatarMartyn Welch <martyn.welch@collabora.com>
parent 8e9c34ed
No related branches found
No related tags found
No related merge requests found
......@@ -8,6 +8,29 @@ is served from gitlab pages.
---
## Document layout
When adding documents to the Apertis Website, please adhere to the following
layout guidelines:
- Policies:
- Documenting procedures and rules
- Minimal requirements for project involvement
- Concepts:
- Topics that have been researched and/or planned but which haven't yet been implemented
- Architecture:
- Description of project infrastructure
- Details of technologies and software used by Apertis
- Guides:
- Guidance on using specific software features
- Worked examples of expected project workflows
- QA:
- Test reports
- Test procedures (realistically, a description of the testing performed and a pointer to qa.apertis.org)
- Releases:
- Release notes
- Release schedules
## GitLab CI
This project's static Pages are built by [GitLab CI][ci], following the steps
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment