search

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

WIP: issue-116-emily #116: Guideline against "pseudo modules" is problematic #161

Closed emmurphy1 closed 3 years ago

emmurphy1 commented 3 years ago

This continues the work done in https://github.com/redhat-documentation/modular-docs/pull/123/files. It resolves issue 116 and issue 99.

emmurphy1 commented 3 years ago

@mikemckiernan and @ncbaratta I have updated with your comments, or explained. Please review when you have time.

emmurphy1 commented 3 years ago

@rkratky @Preeticp @ncbaratta I've revised the text fragments section. Would you mind looking over again and approving if you can?

emmurphy1 commented 3 years ago

@rkratky @ncbaratta @rolfedh @fbolton @fbolton @sterobin @Preeticp @mikemckiernan @yzimmerm I think I have addressed everyone's comments but there have been a few changes so would you mind looking over one last time? Also, I am now second-guessing myself and wondering if we should be talking about 'snippets' instead of 'fragments'? Ideas?

mikemckiernan commented 3 years ago

It still lgtm. My preference for fragments over snippets is to sidestep possible confusion between a text file with limited text content and the feature in Atom that is named snippets and inserts small pieces of text.

ncbaratta commented 3 years ago

I've been saying 'snippets' but seriously I have no preference.