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

Add common Github Wiki content #105

Open
longnd opened this issue Aug 16, 2022 · 0 comments
Open

Add common Github Wiki content #105

longnd opened this issue Aug 16, 2022 · 0 comments
Labels
good first issue Good for new contributors type : chore

Comments

@longnd
Copy link
Contributor

longnd commented Aug 16, 2022

Why

Whenever we set up new infrastructure for a project, despite the fact that we have this infrastructure template to speed up the process, there is one part we still need to do manually (and repeatedly): documenting. Some common parts are the same for every infrastructure and can be generated as part of the template

  • Managing environment variables
  • Infrastructure diagram (There is a template on LucidChart)
  • Connecting to remote DB via bastion instance
  • How to use Terraform Cloud to plan and provision the new changes in a PR

The current documentation for the above parts can be borrowed from an existing project: https://github.com/worpt-wallet/wallet-api/wiki

Who benefits

All developers

@hoangmirs hoangmirs added the good first issue Good for new contributors label Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for new contributors type : chore
Projects
None yet
Development

No branches or pull requests

2 participants