[RFD] Move Booster READMEs to the catalog

[quintesse]

Right now the READMEs that get added to a launched Booster comes from https://github.com/fabric8-launcher/launcher-documentation. To be able to add them to a Booster the Launcher needs to clone that repository and pick out the correct README.

There are several issues I see with this approach:

• Size: The Launcher needs to clone either (a) clone the entire repository or (b) use a sparse checkout. The repository is quite big (14MB as of 2018/4/6) which makes option (a) slow for many people. Option (b) is technically more complex.
• Sync: Having code, metadata and docs spread over several repositories makes it harder to keep things synced. It's easy for the catalog to have new runtimes and missions for which there are no READMEs in the docs repository.
• Community: If we want to turn the Launcher into a community project we probably shouldn't force a system on them that is created because it fits nicely with how RedHat processes and organization work. (The idea being that a separate repository makes it easier for our docs team to update things)

So one suggested solution is that we could move the READMEs (and their properties files) from the docs repository to the booster catalog itself. The booster catalog already has small snippets of information that are managed by the docs team like descriptions, so moving the READMEs doesn't seem like it would make things more difficult for them.

The other solution is that we make do with what we have now, accepting a technically slightly more complex solution, making sure we have good intra-team communication and changing the code in such a way that a community user could easily de-activate our docs solution and create one of their own that fits their needs.

[quintesse]

Mentioning @rhoads-zach here because we talked about this issue. There's no rush, we decided leaving this alone until after Summit (2018).

[Ladicek]

I personally think that READMEs should be in the boosters repositories themselves. If anything, Launcher should just post-process them.

[gastaldi]

I agree with @Ladicek, I don't think it is a good idea to start putting (README) files specific to each Booster in the booster repository, or it will become a maintenance nightmare soon.

The booster catalog could have the content from the properties files used for replacing the variables though, as part of the booster/runtime/mission metadata (maybe under a readme: tag)

[quintesse]

@Ladicek that's indeed another option. But that would be more work for the docs team. They'd need to make changes to each of the (many) booster repos and possibly open a dozen PRs. But I do agree is that it seems the most logical place for READMEs.

[quintesse]

@gastaldi indeed, that was actually my idea too, to put those properties inside the booster yaml files themselves :)