Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Engineer/PM - Slax - Documentation & Creds #351

Open
7 tasks
amandaphu opened this issue Nov 13, 2023 · 0 comments
Open
7 tasks

Engineer/PM - Slax - Documentation & Creds #351

amandaphu opened this issue Nov 13, 2023 · 0 comments

Comments

@amandaphu
Copy link
Contributor

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)
@BunnyDunker BunnyDunker self-assigned this Nov 15, 2023
@BunnyDunker BunnyDunker removed their assignment Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants