-
Notifications
You must be signed in to change notification settings - Fork 669
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
Add environment variables documentation #2200
Conversation
✅ Deploy Preview for tauri-v2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
darn, I have no clue why the build is failing, it seems like something more should be escaped in the markdown but i cant figure out what it is |
hey thanks very much for this, very much needed! is it possible that you could provide the source for these env var? Or are they a compilation found in multiple places? I'll take a quick look as why it's failing to build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you change the formatting to this pattern or something that is easier to navigate?
ENV_VAR
: description
ENV_VAR
: description
ENV_VAR
: description
For instance, this page https://deploy-preview-2200--tauri-v2.netlify.app/start/migrate/from-tauri-1/#environment-variables-changes lists as this:
ENV_VAR
: descriptionENV_VAR
: descriptionENV_VAR
: description
I'm open to ideas, if you have anything in mind...
Some visual references:
https://vitejs.dev/guide/env-and-mode#env-variables
https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
they're practically directly copied from here: I'm not aware of v2 adding more environment variables but if so let me know |
so for now I think this is good, but for the future a improvement could be made to import this file contents into the documentation as a component, so we get the benefit of having always up to date content. Eventually could add extra information, if needed. If you're feeling you want to tackle this, let me know, if not, I'll just check the preview and merge this. |
but now looking at it, the rendered content will be different, have to figure a way to place this tip card nicely. I'll merge this alright |
thanks again |
|
||
Integrate https://github.com/tauri-apps/tauri/blob/dev/tooling/cli/ENVIRONMENT_VARIABLES.md into this page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-_-
just saw this lol
that's actually a great idea, I'll get familiar with astro and look into how to do this. thanks! |
we have a few pages that does this, here you can see one that is in progress but mostly done, https://github.com/tauri-apps/tauri-docs/blob/137bb35ed873efb0536368ba751ae085a60ad12f/src/components/Permissions.astro, just need to fix something upstream. other than that you can take a look at the dir /packages that has config-generator, js-api-generator, releases-generator that mix data importing and handling overall everything that can be done this way, should be. |
What kind of changes does this PR include?
Description
Completes the Stub environment variables page located here