Skip to content

docs[patch]: properly load/use env vars #4711

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 11, 2024
Merged

docs[patch]: properly load/use env vars #4711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a8043f
docs[patch]: properly load/use env vars
bracesproul Mar 11, 2024
ceba3e0
cr
bracesproul Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/core_docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ docs/expression_language/streaming.md
docs/expression_language/streaming.mdx
docs/use_cases/tool_use/human_in_the_loop.md
docs/use_cases/tool_use/human_in_the_loop.mdx
docs/use_cases/query_analysis/quickstart.md
docs/use_cases/query_analysis/quickstart.mdx
docs/use_cases/query_analysis/index.md
docs/use_cases/query_analysis/index.mdx
docs/use_cases/question_answering/streaming.md
docs/use_cases/question_answering/streaming.mdx
docs/use_cases/question_answering/sources.md
Expand All @@ -55,6 +51,10 @@ docs/use_cases/question_answering/citations.md
docs/use_cases/question_answering/citations.mdx
docs/use_cases/question_answering/chat_history.md
docs/use_cases/question_answering/chat_history.mdx
docs/use_cases/query_analysis/quickstart.md
docs/use_cases/query_analysis/quickstart.mdx
docs/use_cases/query_analysis/index.md
docs/use_cases/query_analysis/index.mdx
docs/use_cases/graph/semantic.md
docs/use_cases/graph/semantic.mdx
docs/use_cases/graph/quickstart.md
Expand All @@ -71,18 +71,6 @@ docs/use_cases/extraction/index.md
docs/use_cases/extraction/index.mdx
docs/use_cases/extraction/guidelines.md
docs/use_cases/extraction/guidelines.mdx
docs/use_cases/query_analysis/how_to/no_queries.md
docs/use_cases/query_analysis/how_to/no_queries.mdx
docs/use_cases/query_analysis/how_to/multiple_retrievers.md
docs/use_cases/query_analysis/how_to/multiple_retrievers.mdx
docs/use_cases/query_analysis/how_to/multiple_queries.md
docs/use_cases/query_analysis/how_to/multiple_queries.mdx
docs/use_cases/query_analysis/how_to/high_cardinality.md
docs/use_cases/query_analysis/how_to/high_cardinality.mdx
docs/use_cases/query_analysis/how_to/few_shot.md
docs/use_cases/query_analysis/how_to/few_shot.mdx
docs/use_cases/query_analysis/how_to/constructing_filters.md
docs/use_cases/query_analysis/how_to/constructing_filters.mdx
docs/use_cases/query_analysis/techniques/structuring.md
docs/use_cases/query_analysis/techniques/structuring.mdx
docs/use_cases/query_analysis/techniques/step_back.md
Expand All @@ -95,6 +83,18 @@ docs/use_cases/query_analysis/techniques/expansion.md
docs/use_cases/query_analysis/techniques/expansion.mdx
docs/use_cases/query_analysis/techniques/decomposition.md
docs/use_cases/query_analysis/techniques/decomposition.mdx
docs/use_cases/query_analysis/how_to/no_queries.md
docs/use_cases/query_analysis/how_to/no_queries.mdx
docs/use_cases/query_analysis/how_to/multiple_retrievers.md
docs/use_cases/query_analysis/how_to/multiple_retrievers.mdx
docs/use_cases/query_analysis/how_to/multiple_queries.md
docs/use_cases/query_analysis/how_to/multiple_queries.mdx
docs/use_cases/query_analysis/how_to/high_cardinality.md
docs/use_cases/query_analysis/how_to/high_cardinality.mdx
docs/use_cases/query_analysis/how_to/few_shot.md
docs/use_cases/query_analysis/how_to/few_shot.mdx
docs/use_cases/query_analysis/how_to/constructing_filters.md
docs/use_cases/query_analysis/how_to/constructing_filters.mdx
docs/use_cases/extraction/how_to/parse.md
docs/use_cases/extraction/how_to/parse.mdx
docs/use_cases/extraction/how_to/handle_long_text.md
Expand Down
6 changes: 3 additions & 3 deletions docs/core_docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
// eslint-disable-next-line import/no-extraneous-dependencies
Copy link

Choose a reason for hiding this comment

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

Hey there! I've reviewed the PR and noticed that the addition of require("dotenv").config(); is flagging the change for maintainers to review, as it explicitly accesses and reads environment variables via the process.env object. Great work, and let me know if you need any further assistance!

const { ProvidePlugin } = require("webpack");
const path = require("path");
require("dotenv").config();

const examplesPath = path.resolve(__dirname, "..", "..", "examples", "src");
const mdxComponentsPath = path.resolve(__dirname, "docs", "mdx_components");
Expand Down Expand Up @@ -306,9 +307,8 @@ const config = {
],

customFields: {
NEXT_PUBLIC_SUPABASE_PUBLIC_KEY:
process.env.NEXT_PUBLIC_SUPABASE_PUBLIC_KEY,
NEXT_PUBLIC_SUPABASE_URL: process.env.NEXT_PUBLIC_SUPABASE_URL,
supabasePublicKey: process.env.NEXT_PUBLIC_SUPABASE_PUBLIC_KEY,
supabaseUrl: process.env.NEXT_PUBLIC_SUPABASE_URL,
},
};

Expand Down
1 change: 1 addition & 0 deletions docs/core_docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"@swc/core": "^1.3.62",
"@types/cookie": "^0",
"docusaurus-plugin-typedoc": "1.0.0-next.5",
"dotenv": "^16.4.5",
"eslint": "^8.19.0",
"eslint-config-airbnb": "^19.0.4",
"eslint-config-prettier": "^8.5.0",
Expand Down
6 changes: 4 additions & 2 deletions docs/core_docs/src/theme/Feedback.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* eslint-disable no-return-assign, react/jsx-props-no-spreading */
import React, { useState, useEffect } from "react";
import { createClient } from "@supabase/supabase-js";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";

const useCookie = () => {
/**
Expand Down Expand Up @@ -110,6 +111,7 @@ const getIpAddress = async () => {
export default function Feedback() {
const { setCookie, checkCookie } = useCookie();
const [feedbackSent, setFeedbackSent] = useState(false);
const { siteConfig } = useDocusaurusContext();

/** @param {"good" | "bad"} feedback */
const handleFeedback = async (feedback) => {
Expand All @@ -125,8 +127,8 @@ export default function Feedback() {

/** @type {Database} */
const supabase = createClient(
process.env.NEXT_PUBLIC_SUPABASE_URL,
process.env.NEXT_PUBLIC_SUPABASE_PUBLIC_KEY
siteConfig.customFields.supabaseUrl,
siteConfig.customFields.supabasePublicKey
);
try {
const ipAddress = await getIpAddress();
Expand Down
8 changes: 8 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18664,6 +18664,7 @@ __metadata:
clsx: ^1.2.1
cookie: ^0.6.0
docusaurus-plugin-typedoc: 1.0.0-next.5
dotenv: ^16.4.5
eslint: ^8.19.0
eslint-config-airbnb: ^19.0.4
eslint-config-prettier: ^8.5.0
Expand Down Expand Up @@ -19853,6 +19854,13 @@ __metadata:
languageName: node
linkType: hard

"dotenv@npm:^16.4.5":
version: 16.4.5
resolution: "dotenv@npm:16.4.5"
checksum: 301a12c3d44fd49888b74eb9ccf9f07a1f5df43f489e7fcb89647a2edcd84c42d6bc349dc8df099cd18f07c35c7b04685c1a4f3e6a6a9e6b30f8d48c15b7f49c
languageName: node
linkType: hard

"dpdm@npm:3.12.0":
version: 3.12.0
resolution: "dpdm@npm:3.12.0"
Expand Down