Envoy Documentation Update #160
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
bbengfort
commented
May 8, 2024
rebeccabilbro
approved these changes
May 9, 2024
There was a problem hiding this comment.
Looks great @bbengfort! This will serve as an excellent starting point for the user-facing Envoy docs. I've pushed up some minor edits, and have noted a few follow up tasks to populate in the future (cc @BeciLambrecht):
- In the API reference, the link to the Terms of Service (trisa.io/terms) returns a 404 (screenshots below)
- On the deployment page, there are placeholders for using kubernetes and systemd which look like they should be populated in the future
- Nice to haves:
- Some visual representation of the UI that will help a non-technical compliance officer grok Envoy, e.g link to a video tour of the UI
- Graphical/abstract representation of what work Envoy is doing (e.g. a mermaid diagram), e.g. using a hypothetical transfer
- FAQ / Troubleshooting transfers / Envoy support (e.g. what are some common xfer errors/user mistakes and what to do if you observe them)
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.
This PR adds some documentation for Envoy to help users get started with their Envoy node.