Skip to content

feat: environment variables reference#1986

Merged
jnikhila merged 12 commits into
mainfrom
feat-add-reference-for-env-variables
Dec 15, 2023
Merged

feat: environment variables reference#1986
jnikhila merged 12 commits into
mainfrom
feat-add-reference-for-env-variables

Conversation

@jnikhila

@jnikhila jnikhila commented Dec 14, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Checklist

I have:

  • run the content through Grammarly
  • linked to sample apps when relevant
  • added the meta description for each page in the PR
  • minimized the callouts and added only when necessary
  • added the queryString parameter to the Tabs (if used)
  • masked PII in images. For example, login credentials, account details, and more
  • added images only when necessary
  • deleted the images that are no longer used for the updated pages in the PR
  • followed the image file naming convention while renaming or adding new images. (Use lowercase letters, dashes between words, and be as descriptive as possible)
  • used the <figure/> tag instead of a markdown representation for images
  • added the <figcaption/> tag to add a caption to the image
  • added the alt attribute in the <img/> tag
  • verified and updated the cross-references or created redirect rules for the changed or removed content
  • reviewed and applied the style changes for UI formatting. For example, Bold the UI elements(Buttons on screen) used in the doc.

@vercel

vercel Bot commented Dec 14, 2023 •
edited
Loading

Copy link
Copy Markdown

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

Name Status Preview Comments Updated (UTC)
appsmith-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 15, 2023 8:37am

@jnikhila jnikhila requested a review from sharat87 December 14, 2023 15:48
@jnikhila jnikhila marked this pull request as ready for review December 14, 2023 15:50
sharat87
sharat87 requested changes Dec 15, 2023
View reviewed changes

@sharat87 sharat87 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Can we use level-3 headers under level-2, instead of having level-4 under level-2 please?
  2. I see dd tags without corresponding dt tags. Can we remove the dd tags since they don't seem to be necessary here?
  3. All the env variables have a double underscore after APPSMITH. It should be one underscore only.

@jnikhila

jnikhila commented Dec 15, 2023

Copy link
Copy Markdown
Contributor Author
  1. Can we use level-3 headers under level-2, instead of having level-4 under level-2 please?
    The heading level for environment variables is intentionally kept at level 4 to address formatting concerns. This ensures proper visual distinction between the main headings and subheadings, especially as all environment variable names are in uppercase. For comparison per se, I've updated one head so that we can visualize it. @danciaclara - let me know your thoughts too.
  2. I see dd tags without corresponding dt tags. Can we remove the dd tags since they don't seem to be necessary here?
    That is the formatting we are using across all reference docs.
  3. All the env variables have a double underscore after APPSMITH. It should be one underscore only.
    Fixed

@jnikhila jnikhila requested a review from sharat87 December 15, 2023 04:39
jnikhila
jnikhila commented Dec 15, 2023
View reviewed changes
Comment thread website/docs/getting-started/setup/environment-variables.md

Appsmith can connect to external providers for MongoDB and Redis. The associated environment variables ensure that Appsmith establishes a connection to external hosting rather than using the embedded MongoDB or Redis servers.

#### `APPSMITH_MONGODB_URI`

@jnikhila jnikhila Dec 15, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sharat87 - Could you please provide an example string that I can include here?

jnikhila
jnikhila commented Dec 15, 2023
View reviewed changes
Comment thread website/docs/getting-started/setup/environment-variables.md
Appsmith uses this variable to connect to an external MongoDB instance. Set it to the full MongoDB URI supplied by the hosting service. This enables Appsmith to store data in your MongoDB database, ensuring control and ownership of the application data.
</dd>

#### `APPSMITH_REDIS_URL`

@jnikhila jnikhila Dec 15, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sharat87 - Could you please provide an example string that I can include here?

@jnikhila

jnikhila commented Dec 15, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@sharat87 - Added other envs. Available for final review. The heading level for all env variables is level 4. discussed this with @Dancia too. We agreed to keep it at level 4 to have a visual differentiation for headings and subheadings.

The page is also moved under the configure instance section.

danciaclara
danciaclara suggested changes Dec 15, 2023
View reviewed changes
Comment thread website/docs/getting-started/setup/environment-variables.md Outdated
This variable holds the Client Secret provided by Google for OAuth 2.0. The secret is confidential and used in server-to-server communications. Assign this variable with the Google OAuth 2.0 Client Secret obtained from the Google Cloud Platform console where you configured your OAuth credentials.
</dd>

## Google OAuth

@danciaclara danciaclara Dec 15, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Google OAuth
## GitHub OAuth

@jnikhila jnikhila linked an issue Dec 15, 2023 that may be closed by this pull request
[Docs]: Reference doc for environment variables #1447
Closed
1 task
@jnikhila jnikhila merged commit 655184b into main Dec 15, 2023
@jnikhila jnikhila deleted the feat-add-reference-for-env-variables branch December 15, 2023 13:09
gugulet-hu-spreadai pushed a commit to spread-ai/docs-appsmith-fork that referenced this pull request Sep 30, 2024
@jnikhila
feat: environment variables reference (appsmithorg#1986)
2580428 
## Checklist
I have:
- [x] run the content through Grammarly
- [ ] linked to sample apps when relevant
- [ ] added the meta description for each page in the PR
- [ ] minimized the callouts and added only when necessary
- [ ] added the `queryString` parameter to the Tabs (if used)
- [ ] masked PII in images. For example, login credentials, account
details, and more
- [ ] added images only when necessary
- [ ] deleted the images that are no longer used for the updated pages
in the PR
- [ ] followed the image file naming convention while renaming or adding
new images. (Use lowercase letters, dashes between words, and be as
descriptive as possible)
- [ ] used the `<figure/>` tag instead of a markdown representation for
images
- [ ] added the `<figcaption/>` tag to add a caption to the image
- [ ] added the `alt` attribute in the `<img/>` tag
- [ ] verified and updated the cross-references or created redirect
rules for the changed or removed content
- [ ] reviewed and applied the style changes for UI formatting. For
example, Bold the UI elements(Buttons on screen) used in the doc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sharat87 sharat87 Awaiting requested review from sharat87
1 more reviewer
@danciaclara danciaclara danciaclara approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Docs]: Reference doc for environment variables

3 participants

@jnikhila @sharat87 @danciaclara