PR-3244 Add s3credentialsREADME endpoint #650
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
mattp0
reviewed
Oct 25, 2022
mattp0
previously approved these changes
Oct 25, 2022
reweeden
force-pushed
the
rew/pr-3244-s3credentials-readme
branch
from
5fbd87a to
4cbd454
Compare
mattp0
approved these changes
Oct 28, 2022
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.
I decided to reuse the s3access.md markdown from our tea-docs page for the
/s3credentialsREADMEso that we don't need to maintain two separate docs. This means the one on our tea-docs page will always be up to date for the latest release and the one at/s3credentialsREADMEwill be correct for the version of TEA that's deployed in case we change how the endpoint works at some point.I set it up so the markdown is rendered as part of the build process, the TEA release just contains the rendered html. The css for syntax highlighting is generated with
pygmentize -S default -f html -a .highlight, and the css for the general markdown wrapper is copied from the cumulus-distribution html file.