Skip to content

Update documentation for adding new products to the docs site

Sarah German requested to merge sarahg/new-product-docs into main

What does this MR do and why?

Our "Add a product" documentation has a few missing steps and a few outdated references, as noted in !3152 (comment 1124177022).

This updates the code changes needed to add a new product to the Docs site.

Changes:

  • Adds steps to provide an "Edit on GitLab" link for the page
  • Adds steps for adding Makefile commands for project setup
  • Adds steps for adding the new product to CI tests
  • Adds steps for updating gitlab-docs ... docs
  • Removes the Rakefile addition, this is no longer needed as of !3098 (merged) (we no longer pass branch variables to gitlab-ci.yml)
  • Removes the "Using YAML data files" section in architecture.md; this is duplicated in development.md

Screenshots, screen recordings, or links to review app

n/a

How to set up and validate locally

n/a

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports