Christian Walter has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/40662 )
Change subject: documentation: Add documentation ideas for season of docs ......................................................................
documentation: Add documentation ideas for season of docs
Lets gather some documentation ideas for the season of docs. I reused the project ideas style (thanks patrick). This is WIP - feel free to add new project ideas. I will complete the project description in the next days.
Change-Id: I72221cbd53b99cdc946109753cf72af9c865a1e5 Signed-off-by: Christian Walter christian.walter@9elements.com --- A Documentation/contributing/documentation_ideas.md 1 file changed, 107 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/62/40662/1
diff --git a/Documentation/contributing/documentation_ideas.md b/Documentation/contributing/documentation_ideas.md new file mode 100644 index 0000000..08541d1 --- /dev/null +++ b/Documentation/contributing/documentation_ideas.md @@ -0,0 +1,107 @@ +# Project Ideas + +This section collects ideas to improve the coreboot documentation and +should serve as a pool of ideas for people who want to improve the current +documentation status of coreboot. + +The main purpose of this document is to gather documentation ideas for technical +writers of the seasons of docs. Nevertheless anyone who wants to help improving +the current documentation situation can take one of the projects. + +Each entry should outline what would be done, the benefit it brings +to the project, the pre-requisites, both in knowledge and parts. They +should also list people interested in supporting people who want to work +on them. + +## Refactor Existing Documentation + +The goal is to improve the user experience and structure the documentation more +logically. The current situation makes it very hard for beginners, but also for +experienced developers to find anything in the coreboot documentation. + +One possible approach to restructure the documentation is to split it up such +that we divide the group of users into: + +* (End-)users +Most probably users which _just_ want to use coreboot as fast as possible. This +section should include guidelines on how to build coreboot, how to flash coreboot +and also which hardware is currently supported. + +* Developers +This section should more focus on the developer side-of-view. This section would +include how to get started developing coreboot, explaining the basic concepts of +coreboot and also give guideance on how to proceed after the first steps. + +* Knowledge area +This section is very tighlight coupled to the developer section and might be merged +into the developers section. The _Knowledge area_ can give a technical deep dive +on various drivers, technologies, etc. + +* Community area +This section gives some room for the community: Youtube channels, conferences, +meetups, forums, chat, etc. + +A [https://review.coreboot.org/c/coreboot/+/40327%5D(first approach) has already been made here and might be a basis for the work. +Most of the documentation is already there, but scattered around the documentation +folder. + +### Requirements +* Understanding on how a different groups of users might use the documentation area +* Basic understanding of how coreboot works (Can be worked out _on-the-fly_) + +### Mentors +* christian.walter@9elements.com +* TBD + +## Update Howto/guides + +* Toolchain Building (various distros) +* Logging/Debugging +* VBoot + +### Requirements +* One +* Two + +### Mentors +* TBD +* TBD + +## How to Board Support + +Desc + +### Requirements +* One +* Two + +### Mentors +* TBD +* TBD + +## Payloads + +* Document all known Payloads +* Propose payloads for different use-cases (OS Support, UEFI, etc.) +* How-to build payloads? + +### Requirements +* One +* Two + +### Mentors +* TBD +* TBD + + +## coerboot util documentation + +* Update util documentation + +### Requirements +* One +* Two + +### Mentors +* TBD +* TBD \ No newline at end of file