Go for it, well needed! -- Jason Porter Software Engineer He/Him/His
IBM From: Dominik Hanak <[email protected]> Date: Thursday, February 6, 2025 at 04:50 To: [email protected] <[email protected]> Subject: [EXTERNAL] [PROPOSAL] Fix missing documentation for 10.0.0 Hello Community, here is a proposal on how to resolve the missing documentation for 10.0.0. I think I have a working MVP in a form of pull-request on website so I think it is a good time to get more feedback. You can also vote if you consider this good enough. I also call to arms the SME's of Drools, Kogito & JBPM, I need your help! Github Issue - https://github.com/apache/incubator-kie-issues/issues/1803 Pull-request for website - https://github.com/apache/incubator-kie-website/pull/18 *Summary* Fix missing documentation guides for 10.0.0 release by updating, building the individual docs in (incubator-kie-drools, incubator-kie-kogito-docs, incubator-kie-docs) and including them as static content into the current website. *Details* A new sidebar called Documentation is created with references to Main and Release streams. Main page will summarize development and common information. Release stream pages will showcase each component as Chapter. The individual docs will be included as IFRAME referencing the content in static A workflow action will be modified to: 1. Checkout drools, sonataflow, jbpm, kogito docs repositories 2. Build each 3. Checkout website 4. Copy built docs into the website static folder 5. Build site 6. Deploy site *Status* I am sharing the updates in the github issue,short summary here: * Sonataflow is ready, we might still need to review the compliance to apache guidelines. * Kogito and JBPM are stalled in this PR - https://github.com/apache/incubator-kie-docs/pull/4538 - I am not an SME here so I urge everyone again to help. * Drools had docs moved away from 10.0.x, if someone from SME's can reinstate them and take care of this let me know. I will just include the steps in the workflow to deploy the website. *Goals* Update docs for each component to 10.0.0. Include them in the website deploy process for 10.0.0 Deploy new content for 10.0.0 Let me know what you think, I also suggest to provide feedback directly on PR's Best regards, Dominik
