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

[WIP] - Deployment documentation #74

Open
tracetechnical opened this issue Jun 8, 2022 · 1 comment
Open

[WIP] - Deployment documentation #74

tracetechnical opened this issue Jun 8, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@tracetechnical
Copy link
Contributor

The deployment documentation doesn't give info on commands to run.

As a newly-onboarded developer
I want clear instructions
So that I can deploy the delta backend

@tracetechnical tracetechnical added the documentation Improvements or additions to documentation label Jun 8, 2022
@tracetechnical tracetechnical self-assigned this Jun 8, 2022
@tracetechnical
Copy link
Contributor Author

tracetechnical commented Jun 8, 2022

Missing items by section

Prerequesites

Cloud deployment

  • Are there any dependencies?
  • How to set up dependencies?
  • Access permissions
  • System level env vars for CLI use
  • Other AWS/CDK tools required but not defined in requirements.txt?

Local deployment

  • Are there any dependencies?
  • How to set up dependencies?

Deployment

To The cloud ✈️

  • How to define what environment to deploy to
  • Where to get the various env var values
  • A list of gotchas to beware of
  • What command to run to kick off a deployment

Locally

  • Do we use docker?
  • How does one deploy locally
  • Why would one deploy locally
  • Gotchas
  • Prerequsites

@tracetechnical tracetechnical removed their assignment Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant