docs: update docs from notion (#2684)
Co-authored-by: lucaseduoli <lucaseduoli@users.noreply.github.com>
This commit is contained in:
parent
6756ef22b7
commit
b731983f31
51 changed files with 533 additions and 232 deletions
|
|
@ -9,6 +9,9 @@ slug: /contributing-community
|
|||
## 🤖 Join **Langflow** Discord server {#80011e0bda004e83a8012c7ec6eab29a}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
Join us to ask questions and showcase your projects.
|
||||
|
||||
|
||||
|
|
@ -18,38 +21,32 @@ Let's bring together the building blocks of AI integration!
|
|||
Langflow [Discord](https://discord.gg/EqksyE2EX9) server.
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## 🐦 Stay tuned for **Langflow** on Twitter {#6a17ba5905ad4f7aa5347af7854779f6}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
Follow [@langflow_ai](https://twitter.com/langflow_ai) on **Twitter** to get the latest news about **Langflow**.
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## ⭐️ Star **Langflow** on GitHub {#c903a569934643799bf52b7d1b3514e1}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
You can "star" **Langflow** in [GitHub](https://github.com/langflow-ai/langflow).
|
||||
|
||||
|
||||
By adding a star, other users will be able to find it more easily and see that it has been already useful for others.
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## 👀 Watch the GitHub repository for releases {#d0a089ed717742308bd17430e5ae6309}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
You can "watch" **Langflow** in [GitHub](https://github.com/langflow-ai/langflow). If you select "Watching" instead of "Releases only" you will receive notifications when someone creates a new issue or question. You can also specify that you only want to be notified about new issues, discussions, PRs, etc. so you can try and help them solve those questions.
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
Thanks! 🚀
|
||||
|
||||
|
|
|
|||
|
|
@ -17,5 +17,8 @@ If you're looking for help with your code, consider posting a question on the [
|
|||
## Issue labels {#e19eae656c914ce7aedc4f55565cc0bc}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
[See this page](https://github.com/langflow-ai/langflow/labels) for an overview of the system we use to tag our issues and pull requests.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,24 +6,34 @@ slug: /contributing-how-to-contribute
|
|||
|
||||
|
||||
|
||||
👋 Hello there! We welcome contributions from developers of all levels to our open-source project on [GitHub](https://github.com/langflow-ai/langflow). If you'd like to contribute, please check our contributing guidelines and help make Langflow more accessible.
|
||||
:::info
|
||||
|
||||
This page may contain outdated information. It will be updated as soon as possible.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
👋 Hello there!
|
||||
|
||||
We welcome contributions from developers of all levels to our open-source project on [GitHub](https://github.com/langflow-ai/langflow). If you'd like to contribute, please check our contributing guidelines and help make Langflow more accessible.
|
||||
|
||||
|
||||
|
||||
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether in the form of a new feature, improved infra, or better documentation.
|
||||
|
||||
|
||||
To contribute to this project, please follow a ["fork and pull request"](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow.
|
||||
|
||||
To contribute to this project, please follow a ["fork and pull request"](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow. Please do not try to push directly to this repo unless you are a maintainer.
|
||||
|
||||
|
||||
Please do not try to push directly to this repo unless you are a maintainer.
|
||||
## Local Development {#0388cc3c758d434d994022863a6bafa9}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Local development {#0388cc3c758d434d994022863a6bafa9}
|
||||
|
||||
|
||||
You can develop Langflow using docker compose, or locally.
|
||||
|
||||
|
||||
|
|
@ -42,12 +52,12 @@ This will install the pre-commit hooks, which will run `make format` on every
|
|||
It is advised to run `make lint` before pushing to the repository.
|
||||
|
||||
|
||||
## Run Locally {#5225c2ef0cd6403c9f6c6bbd888115e0}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Run locally {#5225c2ef0cd6403c9f6c6bbd888115e0}
|
||||
|
||||
|
||||
Langflow can run locally by cloning the repository and installing the dependencies. We recommend using a virtual environment to isolate the dependencies from your system.
|
||||
|
||||
|
||||
|
|
@ -68,24 +78,24 @@ And the frontend:
|
|||
`make frontend`
|
||||
|
||||
|
||||
## Docker Compose {#b07f359414ff4220ac615afc364ee46e}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Docker compose {#b07f359414ff4220ac615afc364ee46e}
|
||||
|
||||
|
||||
The following snippet will run the backend and frontend in separate containers. The frontend will be available at `localhost:3000` and the backend at `localhost:7860`.
|
||||
|
||||
|
||||
`docker compose up --build# ormake dev build=1`
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Documentation {#5f34bcaeccdc4489b0c5ee2c4a21354e}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
The documentation is built using [Docusaurus](https://docusaurus.io/). To run the documentation locally, run the following commands:
|
||||
|
||||
|
||||
|
|
@ -104,7 +114,7 @@ The documentation will be available at `localhost:3000` and all the files are
|
|||
New components are added as objects of the [CustomComponent](https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/interface/custom/custom_component/custom_component.py) class and any dependencies are added to the [pyproject.toml](https://github.com/langflow-ai/langflow/blob/dev/pyproject.toml#L27) file.
|
||||
|
||||
|
||||
## Add an example component {#8caae106c853465d83183e7f5272e4d8}
|
||||
### Add an example component {#8caae106c853465d83183e7f5272e4d8}
|
||||
|
||||
|
||||
You have a new document loader called **MyCustomDocumentLoader** and it would look awesome in Langflow.
|
||||
|
|
@ -122,15 +132,24 @@ You have a new document loader called **MyCustomDocumentLoader** and it would
|
|||
## User Sharing {#34ac32e11f344eab892b94531a21d2c9}
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
You might want to share and test your custom component with others, but don't need it merged into the main source code.
|
||||
|
||||
|
||||
If so, you can share your component on the Langflow store.
|
||||
|
||||
|
||||
1. [Register at the Langflow store](https://www.langflow.store/login/).
|
||||
|
||||
|
||||
2. Undergo pre-validation before receiving an API key.
|
||||
|
||||
|
||||
3. To deploy your amazing component directly to the Langflow store, without it being merged into the main source code, navigate to your flow, and then click **Share**. The share window appears:
|
||||
|
||||
|
||||

|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,19 +6,30 @@ slug: /contributing-telemetry
|
|||
|
||||
|
||||
|
||||
:::info
|
||||
|
||||
This page may contain outdated information. It will be updated as soon as possible.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
Our system uses anonymous telemetry to collect essential usage statistics to enhance functionality and user experience. This data helps us identify commonly used features and areas needing improvement, ensuring our development efforts align with what you need.
|
||||
|
||||
|
||||
INFO
|
||||
|
||||
:::note
|
||||
|
||||
We respect your privacy and are committed to protecting your data. We do not collect any personal information or sensitive data. All telemetry data is anonymized and used solely for improving Langflow.
|
||||
|
||||
|
||||
You can opt-out of telemetry by setting the `LANGFLOW_DO_NOT_TRACK` or `DO_NOT_TRACK` environment variable to `true` before running Langflow. This will disable telemetry data collection.
|
||||
|
||||
:::
|
||||
|
||||
## Data Collected Includes: {#1734ed50fb4a4a45aaa84185b44527ca}
|
||||
|
||||
|
||||
|
||||
## Data Collected Includes {#1734ed50fb4a4a45aaa84185b44527ca}
|
||||
|
||||
|
||||
### Run {#2d427dca4f0148ae867997f6789e8bfb}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue