DR-005-Infra: Hosting Strategy for Module Documentation #2089
Conversation
|
|
|
The created documentation from the pull request is available at: docu-html |
| the `eclipse-score-website-published <https://github.com/eclipse-score/eclipse-score-website-published>`_ repo. | ||
| The sources are in the `eclipse-score-website <https://github.com/eclipse-score/eclipse-score-website>`_ repo | ||
| and get deployed automatically using the GitHub Action | ||
| `Build and Archive <https://github.com/eclipse-score/eclipse-score-website/actions/workflows/build_and_publish.yml>`_. |
There was a problem hiding this comment.
The interesting part here was that they plan to drop https://github.com/eclipse-score/eclipse-score-website completely. Therefore those workflows etc will be irrelevant.
There was a problem hiding this comment.
I don't think the plan was to "drop it completely" but rather big reduction.
It is not that relevant for the decision but this is a suitable place to document the status quo, I think.
| 💚 Speed: Faster than option P because many *small* repos. | ||
|
|
||
| 😡 Independence: HelpDesk needed to adapt configuration. (Add repo, rename folder) | ||
|
|
There was a problem hiding this comment.
Let's evaluate another option: direct access to eclipse webserver. This would get rid of our gh-pages branch and therefore all restrictions. But we need to clarify with eclipse whether they can provide that.
|
Did we consider that the builds (doc) should also contain a doxygen and/or rustdoc for modules ? And maybe some other artefacts like branch coverage, static analysis report. |
Co-authored-by: Alexander Lanin <alex@lanin.de> Signed-off-by: Andreas Zwinkau <95761648+a-zw@users.noreply.github.com>
|
What about preview of the build documentation in the PR ? Currently with github this is given. Does this also works with the other options or are there additional effort to support that? |
|
After looking through our work products list (https://eclipse-score.github.io/process_description/main/workproducts/index.html) I can state the following: 1. all the work products (with two exceptions) we want to be part of our Module/Platform documents, 2. The two exceptions are documented here: https://eclipse-score.github.io/process_description/main/process_areas/verification/guidance/verification_process_reqs.html#gd_req__verification_reporting - see also the linked description that these contain e.g. test results and test logs. 3. The process requirement https://eclipse-score.github.io/process_description/main/process_areas/verification/guidance/verification_process_reqs.html#gd_req__verification_report_archiving asks for archiving the verification report for releases. We may even restrict this further to "qualifiable releases". Also this archive does not need to be within github storage. |
I am not aware that we consider generation of doxygen reports - needs to be confirmed by @PandaeDo as the "Implementation Process" expert. |
|
This PR is stale because it has been open for 30 days with no activity. It will be closed in 10 days if no further activity occurs. #magic___^_^___line |
5 participants
Built: https://eclipse-score.github.io/score/pr-2089/design_decisions/DR-005-infra.html