Engineer/PM - Slax - Documentation & Creds #351
Description
Background
In an effort to make SLA transitions better, we should run through project setup and make sure all steps are well documented and include any "gotchas". We should also update the readme to include a general overview of the product with key features and functionality. If there are any other integrations/teams working on the project and who owns what. We should also make sure there is a link to Slax's keybase folder and/or team and ensure all creds are stored there. The deployment process through each environment should also be well documented.
Scenario: Readme Update for Project Setup and Overview
Given I am an engineer/PM
- When I view Slax's readme
- Then it includes well documented project setup steps
- And it includes a project overview with key features/functionality
- And it includes any integrations (i.e. Github)
- And it includes deployment pipeline steps or link to updated release checklist
- And there is a link to Slax's keybase folder and/or team
- List out all creds Slax uses and ensure those creds are in the keybase folder + links (i.e. AWS hosting)