Add docs for Pipelines to DevOps foundations #1035
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MoonMoon1919
requested review from
oredavids,
ebeneliason and
eak12913
as code owners
ebeneliason
reviewed
Aug 11, 2023
There was a problem hiding this comment.
Nice work! This is great. I made a bunch of minor copy edit suggestions, but overall this looks great. I have a few high level thoughts for you to consider:
- Should this replace the "placeholder" page entirely, or is there some other intro you foresee living there instead?
- We still plan to keep a whole dedicated docs section for Pipelines. We should link to that, probably from the mention of "Gruntwork Pipelines" right in the first sentence.
- "Pipelines" as a title isn't incorrect, but I wonder if there's something we can do to make it more clear what this page is about, in context. I'm not sure how to do that without being too verbose, but…something like: Pipelines for Account Factory, or Multi-account Pipeline Architecture, or…?
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Co-authored-by: Eben Eliason <eben@gruntwork.io>
Perhaps! I wasn't sure so I just put it on this separate page
Will add!
Admittedly I struggled with this too, so I just put "pipelines" in there and moved on. Open to suggestions! |
|
@ebeneliason Feedback addressed, thanks! |
ebeneliason
approved these changes
Aug 14, 2023
ellisonc
pushed a commit
that referenced
this pull request
Sep 19, 2023
* Account foundations phase 1 v1 docs * Create section for post control-tower setup actions * Add comments * Add Account Factory Documentation (#1027) * Add account vending documentation --------- Co-authored-by: Eben Eliason <eben.eliason@gmail.com> Co-authored-by: Eben Eliason <eben@gruntwork.io> * Reorg Pipelines docs * Placeholder IA for the new DevOps Foundations docs (#1031) * Address review suggestions * Use ecs-deploy-runner in URLs * Add docs for Pipelines to DevOps foundations (#1035) * Add docs for Pipelines to DevOps foundations * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * Update _docs-sources/foundations/ci-cd/pipelines.md Co-authored-by: Eben Eliason <eben@gruntwork.io> * address PR feedback --------- Co-authored-by: Eben Eliason <eben@gruntwork.io> * feat(CORE-1155): Add beginning of manage accounts (#1058) * Add manage accounts page --------- Co-authored-by: Andrew Ellison <andrew@gruntwork.io> * Add disclaimer about pipelines usage data and how customers can disable it (#1077) * Add disclaimer about usage data and how customers can disable it * feat(CORE-1148): Module Default Docs (#1082) * add module default docs --------- Co-authored-by: Eben Eliason <eben@gruntwork.io> * Feat(CORE-1149): Add docs for folder structure to tf foundations (#1092) * Add docs for folder structure to tf foundations --------- Co-authored-by: Eben Eliason <eben.eliason@gmail.com> * Feature/core 1151 control tower clickops (#1070) * initial docs for enabling control tower * fix root thing * add next steps * Add more detailed step-by-step * Add prerequisites and reformat steps * address pr comments * Add Instructions for Shared Account Permissions * Feat(CORE-1255): Add pipelines code exec docs (2) (#1099) * Add docs on what pipelines is and how it works --------- Co-authored-by: Andrew Ellison <andrew@gruntwork.io> Co-authored-by: Eben Eliason <eben@gruntwork.io> Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com> * feat(CORE-1238): Add upgrade guide from EDR to pipelines v2 (#1115) * Add upgrade guide --------- Co-authored-by: Josh Padnick <josh@gruntwork.io> * Feat(CORE-1238): Add single account tutorial pipelines docs (#1114) * Add single account tutorial pipelines docs --------- Co-authored-by: Oreoluwa Agunbiade <21035422+oredavids@users.noreply.github.com> Co-authored-by: Andrew Ellison <andrew@gruntwork.io> Co-authored-by: Josh Padnick <josh@gruntwork.io> * Add docs for PR workflow and Branch Protection Settings (#1123) * Tweak sidebar (#1118) - Add "external link" SVG to ECS Deploy Runner section - Put "knowledge base" under a "Community" header Co-authored-by: Andrew Ellison <andrew@gruntwork.io> * Feat(CORE-1273): Add pipelines security docs (#1116) * Add pipelines security docs --------- Co-authored-by: Andrew Ellison <andrew@gruntwork.io> * Feature/terraform foundations (#1125) * add terraform foundations link to control tower page * Start terraform foundations docs * add getting started instructions * make the template instructions less repetitive * call out private repo * oops, staged the docs sourcer file * add machine user docs (#1126) * Restore networking section (#1129) * restore networking section and overview pages * restore running apps * forgot a sidebar overview * feat(CORE-1275): Add Enterprise action permissions (#1127) * Add call out for enterprise users to allow workflows from GW org * Add pipelines action overview page and update pipelines overview (#1128) * add pipelines action overview page * add common terms * fix link * Update _docs-sources/pipelines/overview/index.md Co-authored-by: Andrew Ellison <andrew@gruntwork.io> * remove docker talk --------- Co-authored-by: Andrew Ellison <andrew@gruntwork.io> --------- Co-authored-by: Eben Eliason <eben.eliason@gmail.com> Co-authored-by: Eben Eliason <eben@gruntwork.io> Co-authored-by: Ana Krivokapic <ana@gruntwork.io> Co-authored-by: Max Moon <moon.maxwell@gmail.com> Co-authored-by: Andrew Ellison <andrew@gruntwork.io> Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com> Co-authored-by: Josh Padnick <josh@gruntwork.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it is
Adds documentation for how pipelines interacts with accounts created by account factory and how pipelines behaves depending on the change type.