Clarify Documentation & Prevent Secret Leakage #10
+136
−65
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
Instead of having them all above, I figured it would be clearer to have them next to the one they are referring to.
The markup looks like they intended a list—now it IS a list. This will help make things more readable.
These comments are important enough to be included right next to what they describe, especially for people who aren't as familiar with these concepts as Domo engineers are.
That way they're there if needed, but won't be unexpectedly changing things
Instead of a giant wall of text, let's advise the user of what we're about to do
Unfortunately, the admonition makes the step number reset. Using explicit numbers fixes this.
It was in one level too deep, breaking the formatting
This poses a risk of confusing or tripping up people. It seems better to omit it.
This helps the user read and understand what we've written
Previously, it would've been easy for someone to accidentally commit their client id and secret. Now, we make that mistake much harder to make.
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.
Hey @john-aldridge, after the recent problem we had with programmatic filters, I reviewed this example repo.
I noticed a few things that might be unclear to newcomers to DomoEverywhere (like myself), so I dusted off my Technical Communication degree and tried to clarify the docs a little. I made sure to not change the content wherever I could, but instead just structure it in an easier to digest way.
Here's a preview of what it will look like once merged.
There was at least one substantive change I made, though. I made it harder for people to accidentally commit their
.envfile.