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

docs: Update CLI page and add new environment variables page #4311

Merged
merged 18 commits into from
Oct 30, 2024

Conversation

eric-schneider
Copy link
Collaborator

Summary

This PR does the following:

  1. Updates the existing CLI page to match the current state in the latest Langflow release.
  2. Adds a dedicated page about environment variables.

There are many pages/features in the docs that reference or directly involve using environment variables, but up until this point there has been no centralized page that catalogs all of them or describes their general usage. The goal of these updates is to provide make it easier to refer users to these pages for learning general information about the CLI and environment variable options rather than repeating the information in multiple locations across the docs.

Although the Markdown syntax isn't pretty, I was able to add anchors to every environment variable and option so that going forward, we can start linking to them directly from other pages.

Need reviewer help

  1. All environment variables and CLI options are documented in tables. The markdown syntax is difficult to parse, so I highly recommend building the docs and reviewing the HTML.
  2. I used the CLI options and .env.example as a guide for which environment variables to include, but I need feedback on whether there are any variables missing (or if there are any variables that should be removed).
  3. I tried to scrape as much information as I could from the code to determine default values and descriptions, but some info is still missing (and all of the info needs to be verified by SMEs because I'm not fully confident that everything is accurate).

@eric-schneider eric-schneider self-assigned this Oct 29, 2024
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Oct 29, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 29, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 30, 2024
@italojohnny italojohnny enabled auto-merge (squash) October 30, 2024 12:44
@italojohnny italojohnny merged commit d38e79b into main Oct 30, 2024
9 checks passed
@italojohnny italojohnny deleted the docs-cli-reference branch October 30, 2024 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants