-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Architecture revision #3093
Merged
benarent
merged 84 commits into
gravitational:master
from
andyet:andyet/architecture-revision
Oct 22, 2019
Merged
Architecture revision #3093
benarent
merged 84 commits into
gravitational:master
from
andyet:andyet/architecture-revision
Oct 22, 2019
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
First draft of Quickstart, Concept Basics & Structure Reorg
Revert "First draft of Quickstart, Concept Basics & Structure Reorg"
Can one of the admins verify this patch? |
Signed-off-by: Antoine Bardoux <[email protected]>
* Removed hardcoded aws access_keys in favour of customers using IAM and aws credentials.
gravitational#3073) * Clarified IAM docs section + added policy example * Added IAM for DynamoDB to docs
@one000mph This PR still has a few merge conflicts. Could you resolve these please. |
@benarent yep just pushed. |
benarent
approved these changes
Oct 22, 2019
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.
Approving the PR, as per the last PR I'm going to squash / merge. Then perform a cleanup review.
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.
Overview of Changes
Motivation
This PR introduces the Architecture rather than the Architecture Guide. This change attempts to address a couple of issue I saw in the previous docs version.
In this PR I attempted to pull out the key concepts of Teleport and write explainer docs on each of them. I also attempted to eliminate the need for repetitive explanations of concepts in the step-by-step guide. Guides can now focus on practical tasks and provide minimal inline definitions. They will reference users to concept docs for detailed explanations of terms and ideas.
Possible Problems
As I was writing I found that it was hard to describe each concept alone without duplicating some information between docs. For example the Proxy Service relies heavily on the Auth Service so you can't really discuss one without the other. As these are refined it will be challenging to describe each concept clearly while minimizing duplicate information.