This repo acts as an input source for the content of release notes for APIs on the Lighthouse Developer Portal.
- New content is added in a folder structure that matches an expected pattern per each API.
- A pull request gets created by the person requesting the new release note.
- Pull requests, and update commits to those PRs, push proposed changes to dev to allow visual testing.
- Upon PR approval and merge to
main
a GitHub Action will push the content to the Lighthouse Platform Backend (LPB) which will update the content pulled into the developer portal.
- Team Okapi (slack) owns the overall management of this repository and the GitHub Actions that handle the upload of the content to LPB.
- UX (slack) handles the reviews of content updates and approves pull requests.
- The submitter of the PR will be responsible for implementing any required changes prior to PR approval. Also it will be the submitter's responsibility to merge the PR at the time they would like it to go live. The deploy to production is triggered by the merge of the pull request.