Remove module prefixes from IDs in the templates

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

82 stars 68 forks source link

Remove module prefixes from IDs in the templates #198

Closed mjahoda closed 1 year ago

mjahoda commented 1 year ago

The current templates contain module prefixes (proc, con, ref_) in anchors (IDs). This has no benefits, only drawbacks (more characters, worse readability, worse URLs).

Related to the newdoc issue: https://github.com/redhat-documentation/newdoc/issues/21

emmurphy1 commented 1 year ago

This change was approved by the Steering Committee. @mjahoda please create an MR to update the templates.

mjahoda commented 1 year ago

While I'm on it, can I also remove the [role="_abstract"] line from the template files?

emmurphy1 commented 1 year ago

I see that you changed the dash to an underscore for the file name, for all of the templates:

file name: con-my-concept-module-a.adoc
file name: con_my-concept-module-a.adoc While I don't have strong feelings about either one, it is a change that I don't think is necessary or particularly advantageous. When writers who have been following the current convention (con-, proc-, ref-) see this change it could cause confusion.

emmurphy1 commented 1 year ago

@mjahoda yes, please remove the [role="_abstract"] tag.