#98 Reflect the recent Modularity changes: design section + faq
Merged by psabata. Opened by asamalik.
hybrid-modularity  into  master

Download 98.patch

Modularity is undergoing changes [1] and the documentation needs to reflect them.

This is a first PR that addresses the issue. It introduces two things:

  1. A new Design section
    • The Problem to be Solved - why are we doing this
    • Main Concepts - what is a package, a module, a stream, an artifact
    • Building Software - how builds work
    • Consuming Software - installing and managing multiple versions
  2. FAQ

I have built the documentation and uploaded it to my fedorapeople [2] for an easier preview.

Next step will be describing the actual implementation in a new section called "Implementation".

[1] https://communityblog.fedoraproject.org/modularity-dead-long-live-modularity/
[2] https://asamalik.fedorapeople.org/mod-docs-preview/design/intro.html

2 new commits added

  • make archive look nicer
  • fix a few typos

Make sure you spell Fedora with a capital F. I've noticed it's not always the case.

Perhaps rather than saying that Fedora/CentOS are too slow or too fast, consider saying they move too slow or too fast.

Better: "Fedora generally ships the latest stable versions of its component packages when it is released twice per year".

s/less/fewer/

1 new commit added

  • rephrase some bits by applying a PR feedback

@psabata @sgallagh Thanks for the feedback. I have applied the changes you have proposed.

@asamalik, ProblemS maybe? Since you talk about several of them.

@asamalik Figure [1] and figure [2] of the same section have different nodejs module stream names. "Nodejs 6 module" and "Nodejs 6 LST module", respectively. Others in those figures match.

[1] https://asamalik.fedorapeople.org/mod-docs-preview/_images/mod-doc-module.png
[2] https://asamalik.fedorapeople.org/mod-docs-preview/_images/mod-doc-stream.png

and there is no LST in Figure [3]. Where does LST come from? It's confusing.

[3] https://asamalik.fedorapeople.org/mod-docs-preview/_images/mod-doc-artifact.png

+1 to Irina's comment, for consistency.

Anyway, we think it is good enough for now and can be merged. We can fix minor issues later.

Pull-Request has been merged by psabata

Metadata