Skip to content

Reference Implementation Documentation

The Reference Implementation documents in CP Docs provide high level information that describes the reference implementation's use, audience, deployable state, and relevant resources. These documents are not intended to replace the repo ReadMes, which are considered source of truth and usually contain additional in-depth information.

All documents in the Reference Implementation section should follow the same structure and contain the same level of detail. To maintain consistency, the reference_implementation template is available.

To create a Reference Implementation document:

  1. Run the following script, where the doc title matches the title of the repo ReadMe title:

    ./scripts/create_ref_impl.sh "<doc title>" docs

    Note

    The new document will be nested under the Reference Implementation section, which is where all docs of this type should reside. Please refrain from moving it to a different section.

  2. The generated file contains comments with instructions for each section. Replace comments with appropriate information, then remove any remaining comments or empty sections before committing and pushing your changes.

For an example, see Private Route 53 Failover.