redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
80 stars 67 forks source link

Remove prefixes from the IDs in the module templates #201

Closed mjahoda closed 1 year ago

mjahoda commented 1 year ago

https://github.com/redhat-documentation/modular-docs/issues/198

emmurphy1 commented 1 year ago

@mjahoda please update the comments in the template files and check the reference guide as well. For example, in the templates: Base the file name and the ID on the module title. For example:

I

mjahoda commented 1 year ago

@emmurphy1 @thatdocslady Thank you for your hints. I attempted to discover all affected parts but there is still a chance that I have overlooked something. I also noticed two broken xrefs (and two incorrect examples on the same lines), so I fixed them within this PR as well. Please review once again.

mjahoda commented 1 year ago

the edits didn't seem to remove the module/assembly prefix at all, and in fact some of them added prefixes where there were none before

@thatdocslady I double-checked the diff [1] and also the individual commits, and I see only removals of prefixes from IDs. Could you please provide an example (a link or a screenshot from the web UI) of the described problem? Because I'm so used to do everything in Gitlab, there is still a chance that I'm messing something up here on Github.

[1] https://github.com/redhat-documentation/modular-docs/pull/201/files

mjahoda commented 1 year ago

@thatdocslady Now, I see what probably confused you. Within this PR, I also fixed some other things such as broken xrefs. However, I did it in the most straightforward way (fixed an ID according to the existing xrefs, not the other way around). In the internal structure of the mod-docs ref. guide, we have really many things that no longer reflects what we recommend in the guide itself. Fixing all of it will be time-consuming and I believe it's not necessary. The important parts are the published content, the examples, and the template files.

Then, we are still preserving the prefixes in the file names.

Given that, I believe that the goal of this PR - remove prefixes from IDs - is met.