chore(*): add examples in env variables for removing confusion #2194
+7
−0
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.
Summary
Add examples in the env example file so that someone does not have any knowledge on this could be able to navigate.
Background
I was trying to make changes to
entities-plugins
and trying out the new changes via sandboxed env, after the sandbox server booted up, I could barely see anything but a warning dialog on the screen. So I looked into the error found that there were several env variables needs to be configured before the sandbox server can be boot up properly, I had to look up from the code base all the way to slack/confluence to find out how to configure the file.