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

Revert H2 section headings to block headings for procedures, prereqs, and additional resources. #56

Closed sterobin closed 6 years ago

sterobin commented 6 years ago

As discussed in ccs-mod-docs distro list with email subject "Clarification on block heading vs. sub-heading for prereqs, procedures, etc.", I've reverted Procedure, Preq, and Additional headings to previous block format in templates and Ref Guide (.Procedure, .Prerequisites, etc.) everywhere except for Additional resources in assemblies specifically, which should remain an un-discrete "== Additional resources" for now. That too can be reverted to block format once the tooling team finishes the fixes on modules and moves on to assemblies. See the considerations below. I also adjusted some structural inconsistencies in the Ref Guide while I was at it.

Summary of considerations:

Links:

sterobin commented 6 years ago

@ChristyWatkins, @emmurphy1, just tagging you here fyi.

sterobin commented 6 years ago

@rkratky, @ChristyWatkins, @tradej, @asteflova, @agunn, now is probably the time decide on this before we start into the Phase 1 module reviews. It will be hard to ensure consistency in mod doc standards applied in Phase 1 if the review board is not on the same page with headings. I know it's not just me since several others on the board also agree with the proposed change/reversion. If we'd prefer to just leave things as they are for now, I believe making this change later will be even harder, because the H2 heading question affects how a lot of docs are structured, which would need to be manually addressed by writers, and because whatever we prescribe in our reviews would need to be (or should be) all the other docs for each team. And in this case, it would not be a mass-replace tweak easily applied later.

It's up to you all, of course, and I will follow orders, but am bringing it up so that we know the repercussions of postponing this.

tradej commented 6 years ago

Hi, I don't feel strongly one way or another, so the changes can go in as far as I am concerned.

I did just change all labels to the subheadings in the RHOAR documentation, but it took me about 5 minutes to do it with a script, and it will take approximately as much time to change them back, so no problem.

ritz303 commented 6 years ago

@sterobin : I think you (along with others), makes some very valid points, so I'm onboard with this change. ACK.

sterobin commented 6 years ago

So can we merge this then? We have @ritz303, @tradej, and @lbailey (don't see her comment anymore though), and @rkratky and @bhardesty via email, who are on board or have no particular preference. Does anyone else need to sign off for us to merge this? @asteflova? We should probably merge asap before people start reviewing modules for this Thursday's first Module Review Board meeting (July 19). Otherwise reviewers will be prescribing the incorrect heading styles to modules in those reviews.