-
Notifications
You must be signed in to change notification settings - Fork 517
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
docs: rework current repo docs #520
Conversation
Signed-off-by: Alec Holmes <alecholmez@me.com>
@snowp just a quick fix up for docs here |
@alecholmez WDYT about moving this to the |
@jpeach I think that would be a great idea, it looks like most people are using those so maybe we can push the changes through but then also do that? Honestly I don't like these docs since they require updating often especially if we make API changes. IMO looking at the tests are better anyways :) but I do allude to the code example quite a lot to minimize how much I need to change these docs |
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 looks pretty reasonable to me.
@snowp can you give the stamp of approval over here? It looks like James doesn't have repo control yet so his approval didn't allow a merge |
The following guides may be helpful on how to use go-control-plane's Snapshot Cache: | ||
- [Snapshot.md](cache/Snapshot.md) | ||
- [Server.md](cache/Server.md) | ||
- [cache.md](snapshot.md) |
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.
nit: snapshot.md as link text?
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.
Ah oops thank you, it should be cache.md
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 this was merged without updating this change, submitted #535
From envoyproxy#520 Signed-off-by: Sunjay Bhatia <sunjayb@vmware.com>
From #520 Signed-off-by: Sunjay Bhatia <sunjayb@vmware.com>
Signed-off-by: Alec Holmes alecholmez@me.com
closes #513