RFC: Automated Reference Documentation

[ForestEckhardt]

We would like to start generating automate reference documentation for all Paketo buildpacks. In order to do this we will need to make some changes to the buildpacks in the Paketo project to allow for this. Because of the scope of the change we should put together both an RFC as well as a POC of the documentation generation tool.

For the RFC we should discuss the following:

• Overall documentation strategy
• The new structure(s) (i.e. environment metadata in buildpack.toml, new documentation file, etc.) that should be used for reference documentation in Paketo buildpacks
• Alternative documentation methods
• Potential "enforceable" structure or content (build plan diagrams, caching logic)
• Where should a the tooling for documentation generation live?

For the POC we should be able to take a fork the Paketo Bellsoft Liberica buildpack and to the following:

• Convert environment variable fields in buildpack.toml into documentation
• Combine the environment variables documenation with reference-doc.md

[ForestEckhardt]

See paketo-buildpacks/rfcs#114