Skip to content
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

feat(docs): Add page discussing environment variables #10

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jacc
Copy link

@jacc jacc commented Oct 4, 2022

While there is already documentation around project secrets, I could not find anything about environment variables and their distinguishing features versus project secrets. This copy is essentially edited around the project secrets doc page, and might be better off merging variables as a whole into one doc page.

@vercel
Copy link

vercel bot commented Oct 4, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
docs ✅ Ready (Inspect) Visit Preview Oct 6, 2022 at 10:52PM (UTC)

@pxseu
Copy link
Member

pxseu commented Oct 4, 2022

Environment variables and secrets are not interchangeable names. A project secret has its value as any string hover you cannot view it after creation and they are set per project. Environment variables are editable and viewable. They can be any string in addition to a secret ie a secret can be used as an environment variable value.

@imfunniee
Copy link

cobol 👍

@jacc
Copy link
Author

jacc commented Oct 4, 2022

Environment variables and secrets are not interchangeable names. A project secret has its value as any string hover you cannot view it after creation and they are set per project. Environment variables are editable and viewable. They can be any string in addition to a secret ie a secret can be used as an environment variable value.

Gotcha. Will update my PR to include this differentiation. Anything else?

@pxseu
Copy link
Member

pxseu commented Oct 4, 2022

Gotcha. Will update my PR to include this differentiation. Anything else?

Replace

hop deploy --env TOKEN="${env.TOKEN}"

to just

hop deploy --env TOKEN=VALUE

since that caught my eye mostly.

@alii
Copy link
Collaborator

alii commented Oct 4, 2022

& also possible to fix this error when it builds ❤️ —
CleanShot 2022-10-04 at 23 27 32@2x

@alii alii added the hacktoberfest-accepted Add when a PR is accepted as a valid submission for Hacktoberfest label Oct 5, 2022
@alii
Copy link
Collaborator

alii commented Oct 6, 2022

Would it be possible to add some more information under "Usage with API" — perhaps it would be easier to change to an example with the JS SDK

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Add when a PR is accepted as a valid submission for Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants