[FEATURE] Transfer workflows developed in the frame of the rs-documentation repo to the reference-system-documentation repo

[fmorel-ads]

As a Werum developer, I need to have access in the official documentation repository (reference-system-documentation) to the workflows that have been developed in the rs-documentation repo. These workflows are useful for documentation export and management.

The rs-documentation repo will be deleted soon as it is substituted by the reference-system-documentation one. But the workflows associated to the former repo are still needed and shall be maintained in the new repo.

[nleconte-csgroup]

Hello @fmorel-ads I'm not sure to understand what is asked here. Can't the author of the workflows to be migrated from the old repostiry (rs-documentation) just copy the workflows to the new repository (reference-system-documentation) ?

[fmorel-ads]

Hello @nleconte-csgroup ,
the need expressed in this ticket is related to the maintenance of the transferred workflows. It's understood that the author of the workflows will be able to migrate them from their original repo to a new one.

As the destination repo is a common repo shared by CS and Werum developers, the transferred workflows are likely to be commonly used by CS and Werum. So they will have to be maintained, perhaps adapted to specific use or configuration, all along the project. This ticket is created in order to ask for maintenance on these workflows all along the project.

I hope it clarifies. Do not hesitate to call me if not.
Best Regards,
Fanny

[nleconte-csgroup]

Hi @fmorel-adsl

The CS FRANCE F2 Team will maintain the workflow, no problem.

I think we should be able to generate the documentation for each component individually as well as all components at once. Moreover, the reference-system-documentation repository is private, so we are limited by the action/workflow run, and we may not want to waste minutes or space. Is that OK for you ?

Best regards,
Nicolas.

[fmorel-ads]

Hello @nleconte-csgroup ,

Thank you for your answer, the fact that CS France F2 Team will maintain the workflow is great news.

I don't understand your last question. Do you want me to give feedback on the documentation generation (for each component individually AND for all components at once) or on the fact that we are limited in action/workflow?

Thank you in advance !
Fanny

[nleconte-csgroup]

Dear Fanny,

Yes any feedback on the documentation generation workflow is welcome. At the moment, based from what Werum's team already made, I created a workflow to generate the PDF for the component "production-common" (because it's the only one with real documentation). Do not hesitate to have a look on the develop branch : https://github.com/COPRS/reference-system-documentation/tree/develop

The limitation for private repository is a fact, so unless you are a 🧙 wizard 🧙, we do not need any feedback on this point. It was just a reminder that we don't want to generate all the documentation on each modification.

Have a nice weekend !