- 
                Notifications
    You must be signed in to change notification settings 
- Fork 43
Update RefArch Setup Guide - CORE-491 #678
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
Conversation
| ✅ Deploy Preview for pensive-meitner-faaeee ready!
 To edit notification comments on pull requests, go to your Netlify site settings. | 
        
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
      There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few small nits.
| 
 I think I got them all. It's much more consistent having it defined first rather than switching back and forth, great suggestion. I pulled similar comments from the other PR into this one as well to make both guides match as closely as possible. | 
        
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
      | Reference Architecture deployments. | ||
|  | ||
| ## Create and configure AWS Accounts | ||
| First we will create a GitHub Personal Access Token: | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we use PAT here or fully spell out Personal Access Token? WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one felt a little more appropriate to leave full spelled out
        
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                _docs-sources/guides/reference-architecture/configuration-guide/index.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
      |  | ||
| - Then create _another_ secret in AWS Secrets Manager in the _shared_ account containing this PAT. **Note the ARN, as in the GitHub step above**. | ||
| ```bash | ||
| export GITHUB_OAUTH_TOKEN=<YOUR GITHUB PERSONAL ACCESS TOKEN> | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| export GITHUB_OAUTH_TOKEN=<YOUR GITHUB PERSONAL ACCESS TOKEN> | |
| export GITHUB_OAUTH_TOKEN=<YOUR GITHUB PAT> | 
I waffled back on forth on if it was additive to the reader to continue to use PAT even in things like this. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think writing it out here makes sense.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few more small nits. Curious on your thoughts on them.
Otherwise text LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Updating RefArch Setup Guide to better reflect the guide used in the infrastructure-live repo template README, with primary changes around the Machine User section of the guide.
See also: infrastructure-live template PR#75