Docs about AWS hubs and CI/CD automation #717
Conversation
There was a problem hiding this comment.
This is looking like a lot of good content @damianavila! I gave it a quick look-through and have some high-level comments throughout. I can give it a closer pass w/ edits later on after some iterations. I think my biggest questions are around the right location for much of this information. Also kind-of feel like we should treat "automatically deploy a hub" as a pre-requisite for deploying the hub in the first place (AKA, don't make it seem like manually-deploying hubs is an acceptable outcome...that should be a very rare case assuming that our automatic deployment infrastructure works).
If it's helpful to chat about this I'd be happy to hop on a call sometime this week to discuss!
Thanks to Chris' feedback I was able to reorganize the documentation I have written in a minor (placeholder) reference section for our CI/CD system and a how-to guide to set up the CI/CD stuff on AWS clusters. In addition, I have tried to fix some identation problem so I get the expected numbering in the subsections, I tried to be more specific in the referenced (hiperlinked) sections and some other minor fixes such as new notes or removing superfluos admonitions.
There was a problem hiding this comment.
This looks great 🚀 Thanks @damianavila! I left a few comments, but are more about the syntax rather than the content.
There was a problem hiding this comment.
Another quick high-level pass - the structure is much better than last time! I had a few more high-level comments and can dig into the content again after another iteration or two + addressing @GeorgianaElena's comments!
|
Also wanted to bring over a great point from @sgibson91 in a recent issue:
Since we are adding some CI/CD sections here, I think this would be a great place to document which files will trigger new builds if we edit them. |
…he paths starting runs
…bout the semi-automated process on the first AWS hub deploy
|
@choldgraf @GeorgianaElena I think this is ready for another review 😉 . |
choldgraf
changed the title
choldgraf
changed the title
There was a problem hiding this comment.
I just took another pass and pushed a commit with a few edits and clean-ups. I mostly made changes to reduce wordiness and try to make the flow a bit more clear. I think that this is pretty much good to go! We can iterate on this content in subsequent iterations!
|
@damianavila anything you want to finish up here, or shall we merge? |
|
This is ready, let's push the green button. |
|
wahoo! |
This is just the first iteration to put stuff out there for some early feedback (I am pretty sure I have a lot of things to fix on the formatting side).
Btw, I am pretty sure @choldgraf will have a LOT of comments and all of them are welcome.
Starting as draft PR for now, for obvious reasons! 😉