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

Exercise GO API devops documentation #70

Closed
kltm opened this issue Aug 30, 2023 · 4 comments
Closed

Exercise GO API devops documentation #70

kltm opened this issue Aug 30, 2023 · 4 comments
Assignees

Comments

@kltm
Copy link
Member

kltm commented Aug 30, 2023

The deployment documentation needs to be exercised such that a GO developer familiar with the overall project and who has access to the credential store should be able to

  1. deploy a new verion of the API into AWS (for testing, etc)
  2. switch between a currently deployed production version and a new version
@kltm
Copy link
Member Author

kltm commented Aug 30, 2023

This is currently cycling between @sierra-moxon and @abessiari . Once they are complete, we will pass this on to @dustine32 for a final look.

@kltm
Copy link
Member Author

kltm commented Aug 30, 2023

This is the documentation and "debugging" cycle for #14 .

@kltm
Copy link
Member Author

kltm commented Sep 16, 2023

@dustine32 , @sierra-moxon has successfully put out a couple versions of the GO API using the docs. As a final step, would it be possible for you to give it a try next week? I'd be on hand to answer any questions. If not possible, no problem--we'll revisit later on.

kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
kltm added a commit that referenced this issue Sep 21, 2023
@kltm
Copy link
Member Author

kltm commented Sep 22, 2023

@dustine32 and myself gave the documentation a try and, while we were able to get some parts working, had trouble getting the effects we wanted. In general, we're thinking that it might be good to refactor the doc into three parts:

  1. devops environment setup; may be generally useful for other projects as well
  2. general utility and terraform use; may be useful for other projects as well
  3. GO API-specific test and deployment workflow, including names, how to get a fix out, etc.; includes how we want to run devops, names to use, etc.

We've added this to the agenda for the next general go software call.

Will follow up with #78

@kltm kltm closed this as completed Sep 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants