Closed dmarcoux closed 1 year ago
Thanks for your contribution. :+1:
Just one friendly remark regarding this pull requests. I know it's tempting to add TODOs as reminder. However, I would recommend NOT to add them. This gives us a bad reputation and let our readers think the documentation is just "draft". TODOs are for the writer, not for the reader.
However, if you really want to leave some notes in your document which shouldn't be visible to our readers you have two options:
<!-- ... -->
) and add your notes there. This is possible everywhere.<remark>...</remark>
element. This is only visible if the document is rendered in draft mode. However, this is only possible inside block elements or inside division elements (for example, after <section><title>
.Thank you! :slightly_smiling_face:
This PR is a draft and I'm not going to keep the TODOs in the PR whenever I mark it as "ready for review" :slightly_smiling_face:
PR is ready for review now, since the functionality is merged and deployed on the OBS side
To test this locally:
daps2docker .
firefox /tmp/daps2docker-SXo2tVAc/obs-user-guide/html/book.obs-user/cha.obs.scm_ci_workflow_integration.html
(the string afterdaps2-docker-
will be different).Preview of the changes:
DO NOT MERGE: Wait for https://github.com/openSUSE/open-build-service/pull/13498 to be merged and deployed.