From 9fbac00ea26fb0f3c7b5cb4ed3fdb88ec7d5e1fb Mon Sep 17 00:00:00 2001 From: Cezar Vasconcelos Date: Thu, 23 May 2024 17:59:31 -0300 Subject: [PATCH] docs: add styling with admonitions --- docs/docs/integrations/notion/add-content-to-page.md | 3 +-- docs/docs/integrations/notion/list-database-properties.md | 7 ++----- docs/docs/integrations/notion/list-pages.md | 3 +-- docs/docs/integrations/notion/list-users.md | 4 ++-- docs/docs/integrations/notion/page-content-viewer.md | 4 ++-- docs/docs/integrations/notion/page-create.md | 6 +----- docs/docs/integrations/notion/page-update.md | 4 ++-- docs/docs/integrations/notion/search.md | 4 ++-- 8 files changed, 13 insertions(+), 22 deletions(-) diff --git a/docs/docs/integrations/notion/add-content-to-page.md b/docs/docs/integrations/notion/add-content-to-page.md index 6545b369f..eda7e86c8 100644 --- a/docs/docs/integrations/notion/add-content-to-page.md +++ b/docs/docs/integrations/notion/add-content-to-page.md @@ -115,7 +115,7 @@ In this example, the `AddContentToPage` component connects to a `MarkdownLoader` - +## Best Pratices When using the `AddContentToPage` component: @@ -123,7 +123,6 @@ When using the `AddContentToPage` component: - Verify the `block_id` corresponds to the right Notion page/block. - Keep your Notion integration token secure. - Test with sample markdown text before production use. - diff --git a/docs/docs/integrations/notion/list-database-properties.md b/docs/docs/integrations/notion/list-database-properties.md index bd399d4a4..5cb9ca617 100644 --- a/docs/docs/integrations/notion/list-database-properties.md +++ b/docs/docs/integrations/notion/list-database-properties.md @@ -94,16 +94,13 @@ style={{ width: "100%", margin: "20px 0" }} In this example, the `NotionDatabaseProperties` component retrieves the properties of a Notion database, and the retrieved properties are then used as input for subsequent components in the flow. -## Best Practices +## Best Pratices - When using the `NotionDatabaseProperties` component, consider the following best practices: + - Ensure that you have a valid Notion integration token with the necessary permissions to access the desired database. - Double-check the database ID to avoid retrieving properties from the wrong database. - Handle potential errors gracefully by checking the response status and providing appropriate error messages. - - -## Troubleshooting If you encounter any issues while using the `NotionDatabaseProperties` component, consider the following: diff --git a/docs/docs/integrations/notion/list-pages.md b/docs/docs/integrations/notion/list-pages.md index c4bffe66e..df8a4f5f1 100644 --- a/docs/docs/integrations/notion/list-pages.md +++ b/docs/docs/integrations/notion/list-pages.md @@ -157,14 +157,13 @@ In this example, the `NotionListPages ` component is used to retrieve specific pages from a Notion database based on the provided filters and sorting options. The retrieved data can then be processed further in the subsequent components of the flow. - +## Best Pratices When using the `NotionListPages ` component, consider the following best practices: - Ensure that you have a valid Notion integration token with the necessary permissions to query the desired database. - Construct the `query_payload` JSON string carefully, following the Notion API documentation for filtering and sorting options. - If you encounter any issues while using the `NotionListPages` component, consider the following: diff --git a/docs/docs/integrations/notion/list-users.md b/docs/docs/integrations/notion/list-users.md index 191e18b7b..5f6fe4094 100644 --- a/docs/docs/integrations/notion/list-users.md +++ b/docs/docs/integrations/notion/list-users.md @@ -107,12 +107,12 @@ Here's an example of how you can use the `NotionUserList` component in a Langflo - +## Best Pratices + When using the `NotionUserList` component, consider the following best practices: - Ensure that you have a valid Notion integration token with the necessary permissions to retrieve user data. - Handle the retrieved user data securely and in compliance with Notion's API usage guidelines. - diff --git a/docs/docs/integrations/notion/page-content-viewer.md b/docs/docs/integrations/notion/page-content-viewer.md index 69230c08c..0d5e90f13 100644 --- a/docs/docs/integrations/notion/page-content-viewer.md +++ b/docs/docs/integrations/notion/page-content-viewer.md @@ -121,13 +121,13 @@ Here's an example of how you can use the `NotionPageContent` component in a Lang /> - +## Best Pratices + When using the `NotionPageContent` component, consider the following best practices: - Ensure that you have the necessary permissions to access the Notion page you want to retrieve. - Keep your Notion integration token secure and avoid sharing it publicly. - Be mindful of the content you retrieve and ensure that it aligns with your intended use case. - If you encounter any issues while using the `NotionPageContent` component, consider the following: diff --git a/docs/docs/integrations/notion/page-create.md b/docs/docs/integrations/notion/page-create.md index 591436df2..5ca37301b 100644 --- a/docs/docs/integrations/notion/page-create.md +++ b/docs/docs/integrations/notion/page-create.md @@ -111,17 +111,13 @@ Here's an example of how to use the `NotionPageCreator` component in a Langflow ## Best Practices - When using the `NotionPageCreator` component, consider the following best practices: + - Ensure that you have a valid Notion integration token with the necessary permissions to create pages in the specified database. - Properly format the `properties` input as a JSON string, matching the structure and field types of your Notion database. - Handle any errors or exceptions that may occur during the page creation process and provide appropriate error messages. - To avoid the hassle of messing with JSON, we recommend using the LLM to create the JSON for you as input. - - -## Troubleshooting - If you encounter any issues while using the `NotionPageCreator` component, consider the following: - Double-check that the `database_id` and `notion_secret` inputs are correct and valid. diff --git a/docs/docs/integrations/notion/page-update.md b/docs/docs/integrations/notion/page-update.md index 74c20e8b7..a81cba05b 100644 --- a/docs/docs/integrations/notion/page-update.md +++ b/docs/docs/integrations/notion/page-update.md @@ -116,13 +116,13 @@ Here's an example of how to use the `NotionPageUpdate` component in a Langflow f /> - +## Best Pratices + When using the `NotionPageUpdate` component, consider the following best practices: - Ensure that you have a valid Notion integration token with the necessary permissions to update page properties. - Handle edge cases and error scenarios gracefully, such as invalid JSON format for properties or API request failures. - We recommend using an LLM to generate the inputs for this component, to allow flexibilty - If you encounter any issues while using the `NotionPageUpdate` component, consider the following: diff --git a/docs/docs/integrations/notion/search.md b/docs/docs/integrations/notion/search.md index 31f298ce6..0391c8141 100644 --- a/docs/docs/integrations/notion/search.md +++ b/docs/docs/integrations/notion/search.md @@ -160,14 +160,14 @@ Here's an example of how you can use the `NotionSearch` component in a Langflow In this example, the `NotionSearch` component is used to search for pages and databases in Notion based on the provided query and filter criteria. The retrieved data can then be processed further in the subsequent components of the flow. - +## Best Pratices + When using the `NotionSearch` component, consider the following best practices: - Ensure that you have a valid Notion integration token with the necessary permissions to search for pages and databases. - Provide a meaningful search query to narrow down the results to the desired pages or databases. - Choose the appropriate filter type (`page` or `database`) based on your search requirements. - Consider the sorting direction (`ascending` or `descending`) to organize the search results effectively. - If you encounter any issues while using the `NotionSearch` component, consider the following: