jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: update docs for global variables page and security (#4878)

Browse source 
* Added best practices document

* Refactored global variables page

* added category

* move-security-page

* link

* Removed title from Security Best Practices

* Avoid empty headings

* Sentence case for headings

* Remove general best practices not related to Langflow

* Add bulleted list instead of numbered list

* changed default secret locations to use the default secret key locations

* Add periods on end of sentences

* Changed title to be imperative

---------

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
This commit is contained in:
Lucas Oliveira 2024-12-02 16:32:57 -03:00 • committed by GitHub
commit 008c65b6b7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 183 additions and 141 deletions
Download patch file Download diff file Expand all files Collapse all files

171
docs/sidebars.js
View file

@ -1,17 +1,17 @@
module.exports = {
docs: [
'Get-Started/welcome-to-langflow',
"Get-Started/welcome-to-langflow",
{
type: 'category',
label: 'Get Started',
type: "category",
label: "Get Started",
items: [
'Get-Started/get-started-installation',
'Get-Started/get-started-quickstart',
"Get-Started/get-started-installation",
"Get-Started/get-started-quickstart",
],
},
{
type: 'category',
label: 'Starter Projects',
type: "category",
label: "Starter Projects",
items: [
'Starter-Projects/starter-projects-basic-prompting',
'Starter-Projects/starter-projects-blog-writer',
@ -24,124 +24,127 @@ module.exports = {
],
},
{
type: 'category',
label: 'Workspace',
type: "category",
label: "Workspace",
items: [
'Workspace/workspace-overview',
'Workspace/workspace-api',
'Workspace/workspace-logs',
'Workspace/workspace-playground',
"Workspace/workspace-overview",
"Workspace/workspace-api",
"Workspace/workspace-logs",
"Workspace/workspace-playground",
],
},
{
type: 'category',
label: 'Agents',
type: "category",
label: "Agents",
items: [
'Agents/agents-overview',
'Agents/agent-tool-calling-agent-component',
"Agents/agents-overview",
"Agents/agent-tool-calling-agent-component",
],
},
{
type: 'category',
label: 'Configuration',
type: "category",
label: "Configuration",
items: [
'Configuration/configuration-api-keys',
'Configuration/configuration-authentication',
'Configuration/configuration-auto-saving',
'Configuration/configuration-backend-only',
'Configuration/configuration-cli',
'Configuration/configuration-global-variables',
'Configuration/environment-variables',
"Configuration/configuration-api-keys",
"Configuration/configuration-authentication",
"Configuration/configuration-auto-saving",
"Configuration/configuration-backend-only",
"Configuration/configuration-cli",
"Configuration/configuration-global-variables",
"Configuration/environment-variables",
"Configuration/configuration-security-best-practices"
],
},
{
type: 'category',
label: 'Components',
type: "category",
label: "Components",
items: [
'Components/components-overview',
'Components/components-agents',
'Components/components-custom-components',
'Components/components-data',
'Components/components-embedding-models',
'Components/components-helpers',
'Components/components-io',
'Components/components-loaders',
'Components/components-logic',
'Components/components-memories',
'Components/components-models',
'Components/components-prompts',
'Components/components-rag',
'Components/components-tools',
'Components/components-vector-stores',
"Components/components-overview",
"Components/components-agents",
"Components/components-custom-components",
"Components/components-data",
"Components/components-embedding-models",
"Components/components-helpers",
"Components/components-io",
"Components/components-loaders",
"Components/components-logic",
"Components/components-memories",
"Components/components-models",
"Components/components-prompts",
"Components/components-rag",
"Components/components-tools",
"Components/components-vector-stores",
],
},
{
type: 'category',
label: 'Guides',
type: "category",
label: "Guides",
items: [
'Guides/guides-chat-memory',
'Guides/guides-data-message',
'Guides/guides-new-to-llms',
"Guides/guides-chat-memory",
"Guides/guides-data-message",
"Guides/guides-new-to-llms",
],
},
{
type: 'category',
label: 'Deployment',
type: "category",
label: "Deployment",
items: [
'Deployment/deployment-docker',
'Deployment/deployment-gcp',
'Deployment/deployment-hugging-face-spaces',
'Deployment/deployment-kubernetes',
'Deployment/deployment-railway',
'Deployment/deployment-render',
"Deployment/deployment-docker",
"Deployment/deployment-gcp",
"Deployment/deployment-hugging-face-spaces",
"Deployment/deployment-kubernetes",
"Deployment/deployment-railway",
"Deployment/deployment-render",
],
},
{
type: 'category',
label: 'Integrations',
type: "category",
label: "Integrations",
items: [
'Integrations/integrations-assemblyai',
'Integrations/integrations-langfuse',
'Integrations/integrations-langsmith',
'Integrations/integrations-langwatch',
"Integrations/integrations-assemblyai",
"Integrations/integrations-langfuse",
"Integrations/integrations-langsmith",
"Integrations/integrations-langwatch",
{
type: 'category',
label: 'Google',
items: ['Integrations/Google/integrations-setup-google-oauth-langflow'],
type: "category",
label: "Google",
items: [
"Integrations/Google/integrations-setup-google-oauth-langflow",
],
},
{
type: 'category',
label: 'Notion',
type: "category",
label: "Notion",
items: [
'Integrations/Notion/integrations-notion',
'Integrations/Notion/notion-agent-conversational',
'Integrations/Notion/notion-agent-meeting-notes',
"Integrations/Notion/integrations-notion",
"Integrations/Notion/notion-agent-conversational",
"Integrations/Notion/notion-agent-meeting-notes",
],
},
],
},
{
type: 'category',
label: 'Contributing',
type: "category",
label: "Contributing",
items: [
'Contributing/contributing-community',
'Contributing/contributing-components',
'Contributing/contributing-github-discussion-board',
'Contributing/contributing-github-issues',
'Contributing/contributing-how-to-contribute',
'Contributing/contributing-telemetry',
"Contributing/contributing-community",
"Contributing/contributing-components",
"Contributing/contributing-github-discussion-board",
"Contributing/contributing-github-issues",
"Contributing/contributing-how-to-contribute",
"Contributing/contributing-telemetry",
],
},
{
type: 'category',
label: 'API Reference',
type: "category",
label: "API Reference",
items: [
{
type: 'link',
label: 'API Documentation',
href: '/api',
type: "link",
label: "API Documentation",
href: "/api",
},
],
},
],
};
};