Technical documentation at oniroproject.org
Summary
Oniro technical documentation is currently at readthedocs.org. One of Oniro subprojects will reach its first milestone in the coming weeks and we would like to open the door to publishing the technical documentation under our own domain oniroproject.org , starting with this subproject called EDDIE
Description
The EDDIE project is close to reach a milestone. This is a subproject of oniro-core project. We would like to start creating the technical documentation and publish it in preparation for the milestone of this particular subproject.
Instead of doing it in readthedocs.org as the current Oniro documentation, we would like to do it under our own domain, as part of our website. Additional technical documentation will follow. This is the first time we try to do something like this at Oniro. I would appreciate some information regarding...
- Requirements we would need to meet to be able to publish technical documentation under oniroproject.org domain.
- Information we would need to consider in order to push documentation on regular basis and process to do so.
- Technology involved.
- Should we use any specific template?
- Any other consideration for Oniro developers in order for them to reach the goal.
Additional information for the webdev team:
- This is the link to the existing Oniro technical documentation: https://docs.oniroproject.org/en/latest/
- How we are currently creating and publishing the documentation at Oniro: https://docs.oniroproject.org/en/latest/building-project-documentation.html
- Oniro website: http://www.oniroproject.org
- EDDIE subproject: https://gitlab.eclipse.org/eclipse/oniro-core/eddie
cc @toscalix
Priority
-
Urgent -
High -
Medium -
Low
Severity
-
Blocker -
Major -
Normal -
Low
Impact
This is of low impact since it only affects Oniro. This is a recurrent task we want to learn about so we become independent and push technical documentation to the website on regular basis