Add docs for multi repo pipelines #1142
Conversation
✅ Deploy Preview for pensive-meitner-faaeee ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
It's pretty cool to see this laid out, and we get our first instance of configuring something! I left some comments on where to put the content, adding more context on when this would make sense, and on the config file itself.
The one other helpful thing would be to write more about the security implications of adding another repo. I guess that means that whoever controls the main branch of that repo can execute with the full AWS permissions granted in this repo, so we should probably give a warning or overview of what kind of trust assertions you need to be able to make before you can responsibly add another infra-live repo.
| label: "Multiple Infrastructure-Live Repos", | ||
| type: "doc", | ||
| id: "pipelines/multi-account/index", | ||
| }, |
There was a problem hiding this comment.
This feels like it goes beyond the scope of "getting started." Should we introduce a new section called "Configuration" and put it in there? Perhaps we could also move the following content to that section:
- The GitHub Enterprise Users section of the "Using Pipelines" page (that could go under its own page called "GitHub Enterprise")
- Usage data
- Repository access (maybe?)
There was a problem hiding this comment.
I moved some stuff around mostly into security, let me know if you like this layout better
There was a problem hiding this comment.
These changes look great! The product is starting to shape up nicely. :)
As an aside, it may be worth explicitly linking to some of the security and multiple infra-live repos pages at the bottom of http://localhost:3000/pipelines/hello-world/#next-steps.
I left a few final comments. Please incorporate this feedback according to your judgment, and then let's merge and mark this done!
|
|
||
| We recommend using a single `infrastructure-live` repository for managing your organization's infrastructure. | ||
| Sometimes, this isn't possible due to team structure, security requirements, or other limitations. | ||
| You may choose to use multiple repos to: |
There was a problem hiding this comment.
| You may choose to use multiple repos to: | |
| You may choose to use multiple `infrastructure-live` repos to: |
| @@ -0,0 +1,54 @@ | |||
| # Multiple Infrastructure-Live Repos | |||
There was a problem hiding this comment.
Nit: I personally find it easier to review and maintain the content when it's all on one line versus us manually adding line breaks.
There was a problem hiding this comment.
sorry, bad habit from Garmin where they very strictly enforced the 80 character line limit even in text files
There was a problem hiding this comment.
Oh interesting. Yeah, let's standardize on one line then.
…ulti-repo # Conflicts: # _docs-sources/pipelines/security/branch-protection.md # docs/pipelines/security/branch-protection.md
|
I would suggest re-running the regenerate docs command locally( |
No description provided.