diff --git a/app/docs/changelog/[...slug]/page.tsx b/app/docs/changelog/[...slug]/page.tsx index 730b27e8..3c7c1171 100644 --- a/app/docs/changelog/[...slug]/page.tsx +++ b/app/docs/changelog/[...slug]/page.tsx @@ -2,7 +2,6 @@ import {changelogSource} from '@/lib/source'; import {DocsBody, DocsDescription, DocsTitle,} from 'fumadocs-ui/page'; import {notFound} from 'next/navigation'; import {getMDXComponents} from '@/mdx-components'; -import MdxLink from "@/components/mdx/MdxLink"; import { AnchorProvider } from 'fumadocs-core/toc'; import { Toc, TOCScrollArea} from 'fumadocs-ui/components/layout/toc'; import ClerkTOCItems from 'fumadocs-ui/components/layout/toc-clerk'; @@ -32,9 +31,7 @@ export default async function Page(props: { {page.data.description} diff --git a/app/docs/scripts/[[...slug]]/page.tsx b/app/docs/scripts/[[...slug]]/page.tsx index b66dbbfb..1edae8ac 100644 --- a/app/docs/scripts/[[...slug]]/page.tsx +++ b/app/docs/scripts/[[...slug]]/page.tsx @@ -2,7 +2,6 @@ import {scriptsSource} from '@/lib/source'; import {DocsBody, DocsDescription, DocsTitle,} from 'fumadocs-ui/page'; import {notFound} from 'next/navigation'; import {getMDXComponents} from '@/mdx-components'; -import MdxLink from "@/components/mdx/MdxLink"; import { AnchorProvider } from 'fumadocs-core/toc'; import { Toc, TOCScrollArea, } from 'fumadocs-ui/components/layout/toc'; import ClerkTOCItems from 'fumadocs-ui/components/layout/toc-clerk'; @@ -32,9 +31,7 @@ export default async function Page(props: { {page.data.description} diff --git a/app/docs/self-hosting/[[...slug]]/page.tsx b/app/docs/self-hosting/[[...slug]]/page.tsx index ea9bf096..3427793b 100644 --- a/app/docs/self-hosting/[[...slug]]/page.tsx +++ b/app/docs/self-hosting/[[...slug]]/page.tsx @@ -32,9 +32,7 @@ export default async function Page(props: { {page.data.description} diff --git a/components/mdx/MdxLink.tsx b/components/mdx/MdxLink.tsx index 50105690..c015ed6b 100644 --- a/components/mdx/MdxLink.tsx +++ b/components/mdx/MdxLink.tsx @@ -6,6 +6,14 @@ const transformHref = (href: string) => { return href; } + if (href.startsWith('/docs/product-docs')) { + return href; + } + + if(href.startsWith('/docs/self-hosting')) { + return href + } + if (href.startsWith('/docs')) { return `/docs/product-docs/${href}`; } diff --git a/content/docs/FAQs.md b/content/docs/FAQs.md index 17d0850d..dea8859b 100644 --- a/content/docs/FAQs.md +++ b/content/docs/FAQs.md @@ -6,7 +6,7 @@ icon: "helpCircle" ## How to upgrade NocoDB ? -- Please see [here](https://docs.nocodb.com/getting-started/upgrading) +- Please see [here](/docs/self-hosting/upgrading) ## How to export CSV from the grid view ? diff --git a/content/docs/automation/webhook/create-webhook.mdx b/content/docs/automation/webhook/create-webhook.mdx index 805858e0..c93a2646 100644 --- a/content/docs/automation/webhook/create-webhook.mdx +++ b/content/docs/automation/webhook/create-webhook.mdx @@ -344,4 +344,4 @@ One can also customize the payload as per the requirement. For example, to send In self-hosted version, you can configure the following environment variables to customize the webhook behavior. - NC_ALLOW_LOCAL_HOOKS: Allow localhost based links to be triggered. Default: false -Find more about environment variables [here](/getting-started/self-hosted/environment-variables) \ No newline at end of file +Find more about environment variables [here](/docs/self-hosting/environment-variables) \ No newline at end of file diff --git a/content/docs/developer-resources/webhook/create-webhook.mdx b/content/docs/developer-resources/webhook/create-webhook.mdx index 7e633522..dc3a9f8e 100644 --- a/content/docs/developer-resources/webhook/create-webhook.mdx +++ b/content/docs/developer-resources/webhook/create-webhook.mdx @@ -322,4 +322,4 @@ One can also customize the payload as per the requirement. For example, to send In self-hosted version, you can configure the following environment variables to customize the webhook behavior. - NC_ALLOW_LOCAL_HOOKS: Allow localhost based links to be triggered. Default: false -Find more about environment variables [here](/getting-started/self-hosted/environment-variables) +Find more about environment variables [here](/docs/self-hosting/environment-variables) diff --git a/content/docs/engineering/writing-docs.mdx b/content/docs/engineering/writing-docs.mdx index 0c4d46ff..3c8e844a 100644 --- a/content/docs/engineering/writing-docs.mdx +++ b/content/docs/engineering/writing-docs.mdx @@ -8,12 +8,21 @@ This article discusses some of the protocol and conventions to be followed while ## Folder Structure - Docs follow object-oriented approach. Each folder represents an object and each file represents procedures associated with that object. -- Each folder contains an `_category_.json` file which contains the metadata for that object. +- Each folder contains an `meta.json` file which contains the metadata for that object. ``` { - "label": "Engineering", - "collapsible": true, - "collapsed": true + "title": "Engineering", + "icon": "terminal", + "pages": [ + "architecture", + "repository-structure", + "development-setup", + "unit-testing", + "playwright", + "build-and-releases", + "translations", + "writing-docs" + ] } ``` @@ -35,9 +44,7 @@ keywords: ['Engineering', Writing docs', 'Docs conventions'] ## Nomenclature - Folder names & file name are - in kebab-case. - - prefix with a number that represents the order in which the folder/file should be displayed in the sidebar. - - prefix number is always a 3-digit number. - - For example, `010.account-settings`. + - For example, `account-settings`. - Only first letter of the folder/file name is capitalized. Second letter onwards, first letter is capitalized only if it is a proper noun. ## Tags @@ -61,6 +68,6 @@ Tags that are currently being used in the docs are listed below. See if you can - Use `Skitch` for annotations. ## Before you commit -- Use `npm run build` to build the docs. +- Use `pnpm run build` to build the docs. - Ensure that the build is successful & there are no errors/warnings related to missing links, images, etc. diff --git a/content/docs/fields/field-types/numerical/number.mdx b/content/docs/fields/field-types/numerical/number.mdx index c54dbf8f..12b9ea99 100644 --- a/content/docs/fields/field-types/numerical/number.mdx +++ b/content/docs/fields/field-types/numerical/number.mdx @@ -17,10 +17,10 @@ keywords: ['Fields', 'Field types', 'Numerical types', 'Number', 'Create number ![image](/img/v2/fields/types/number.png) -:::info + - This field type can hold both positive and negative numbers. - Supported range (JavaScript): -9007199254740991 to 9007199254740991 -::: + ## Similar numerical fields Following are the other numerical fields available in NocoDB, with some custom add-on features. diff --git a/content/docs/getting-started/quick-start.mdx b/content/docs/getting-started/quick-start.mdx index 6f6f18e9..2850e689 100644 --- a/content/docs/getting-started/quick-start.mdx +++ b/content/docs/getting-started/quick-start.mdx @@ -16,9 +16,9 @@ When you opt for self-hosting, you gain the advantage of running an application Setting up NocoDB on your own server is a straightforward process & the articles below will guide you through the steps to get started. -- [Installation](/getting-started/self-hosted/installation/auto-upstall) -- [Environment Variables](/getting-started/self-hosted/environment-variables) -- [Upgrading](/getting-started/self-hosted/upgrading) +- [Installation](/docs/self-hosting/installation/auto-upstall) +- [Environment Variables](/docs/self-hosting/environment-variables) +- [Upgrading](/docs/self-hosting/upgrading) ## SaaS (Cloud Hosted) diff --git a/content/docs/index.mdx b/content/docs/index.mdx index 793b646b..2b240021 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -27,7 +27,7 @@ Also, NocoDB's app store allows you to build business workflows on views with co ### App Store for Workflow Automations -We provide different integrations in three main categories. See App Store for details. +We provide different integrations in three main categories. See [App Store](/account-settings/oss-specific-details#app-store) for details. - ⚡  Chat : Slack, Discord, Mattermost, and etc - ⚡  Email : AWS SES, SMTP, MailerSend, and etc @@ -43,11 +43,11 @@ We provide the following ways to let users invoke actions in a programmatic way. ### Sync Schema -We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from environment to others. See Sync Schema for details. +We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from environment to others. See [Sync Schema](data-sources/sync-with-data-source) for details. ### Audit -We are keeping all the user operation logs under one place. See Audit for details. +We are keeping all the user operation logs under one place. See [Audit](data-sources/actions-on-data-sources#audit-logs) for details. ## Why are we building this? Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in the future. diff --git a/content/docs/views/actions-on-view.mdx b/content/docs/views/actions-on-view.mdx index 47204e04..7e113eb5 100644 --- a/content/docs/views/actions-on-view.mdx +++ b/content/docs/views/actions-on-view.mdx @@ -90,9 +90,9 @@ This filters records where the field `country` is equal to `France`. ### Supported Operators List of supported operators for filtering across various data types are listed below -- [Comparison Operators](/developer-resources/rest-APIs/overview#comparison-operators) -- [Comparison Sub Operators](/developer-resources/rest-APIs/overview#comparison-sub-operators) -- [Logical Operators](/developer-resources/rest-APIs/overview#logical-operators) +- [Comparison Operators](/developer-resources/rest-apis/overview#comparison-operators) +- [Comparison Sub Operators](/developer-resources/rest-apis/overview#comparison-sub-operators) +- [Logical Operators](/developer-resources/rest-apis/overview#logical-operators) ### Combining Filters diff --git a/content/self-hosting/environment-variables.mdx b/content/self-hosting/environment-variables.mdx index 545a9471..8b3c0851 100644 --- a/content/self-hosting/environment-variables.mdx +++ b/content/self-hosting/environment-variables.mdx @@ -17,7 +17,7 @@ performance, security, and functionality of NocoDB. | `NC_DB_JSON_FILE` | No | A path to a knex connection JSON file can be used to specify the database connection, as an alternative to `NC_DB`. | | | `DATABASE_URL` | No | A [JDBC URL string](https://jdbc.postgresql.org/documentation/use/#connecting-to-the-database) can be used for the database connection instead of `NC_DB`. | | | `DATABASE_URL_FILE` | No | A path to a file containing a JDBC URL can be specified for the database connection as an alternative to `NC_DB`. | | -| `NC_CONNECTION_ENCRYPT_KEY` | No | The key used to encrypt the credentials of external databases.
**Warning:** Changing this variable may break the application. If you must change it, use the CLI as described in the [NocoDB Secret CLI documentation](/data-sources/updating-secret). | Keep connection credentials as plain text in the database if not set. | +| `NC_CONNECTION_ENCRYPT_KEY` | No | The key used to encrypt the credentials of external databases.
**Warning:** Changing this variable may break the application. If you must change it, use the CLI as described in the [NocoDB Secret CLI documentation](/docs/product-docs/data-sources/updating-secret). | Keep connection credentials as plain text in the database if not set. | ## Authentication @@ -46,7 +46,7 @@ To update **either** `NC_ADMIN_EMAIL` or `NC_ADMIN_PASSWORD`, you must set **bot | `NC_S3_ACCESS_SECRET` | No | The AWS access secret associated with the S3 storage plugin. Required if no role access in use. | | | `NC_S3_FORCE_PATH_STYLE` | No | Whether to force [path-style requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#path-style-access) for the S3 storage plugin. | | | `NC_S3_ACL` | No | The [ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html) for the objects in S3 | | -| `NC_ATTACHMENT_FIELD_SIZE` | No | Maximum file size allowed for [attachments](/fields/field-types/custom-types/attachment/) in bytes. | Defaults to `20971520` (20 MiB). | +| `NC_ATTACHMENT_FIELD_SIZE` | No | Maximum file size allowed for [attachments](/docs/product-docs/fields/field-types/custom-types/attachment/) in bytes. | Defaults to `20971520` (20 MiB). | | `NC_NON_ATTACHMENT_FIELD_SIZE` | No | Sets the maximum size in bytes for individual non-attachment form fields during multipart uploads. Useful for increasing limit for large text or JSON fields to prevent 'Field value too long' errors. | Defaults to `1MB` (based on `multer`'s default field size limit). | | `NC_MAX_ATTACHMENTS_ALLOWED` | No | Maximum number of attachments allowed per cell. | Defaults to `10`. | @@ -100,7 +100,7 @@ To update **either** `NC_ADMIN_EMAIL` or `NC_ADMIN_PASSWORD`, you must set **bot | `DB_QUERY_LIMIT_MAX` | No | Maximum allowable pagination limit. | Defaults to `1000`. | | `DB_QUERY_LIMIT_MIN` | No | Minimum allowable pagination limit. | Defaults to `10` | | `NC_CONNECT_TO_EXTERNAL_DB_DISABLED` | No | Disables the ability to create bases on external databases. | | -| `NC_INVITE_ONLY_SIGNUP` | No | Disables public signup; signup is possible only via invitations. Integrated into the [super admin settings menu](/account-settings/oss-specific-details#enable--disable-signup) as of version 0.99.0. | | +| `NC_INVITE_ONLY_SIGNUP` | No | Disables public signup; signup is possible only via invitations. Integrated into the [super admin settings menu](/docs/product-docs/account-settings/oss-specific-details#enable--disable-signup) as of version 0.99.0. | | | `NC_REQUEST_BODY_SIZE` | No | Maximum bytes allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resources/middleware/body-parser.html#limit). | Defaults to `1048576` (1 MB). | | `NC_ALLOW_LOCAL_HOOKS` | No | Allows webhooks to call local network links, posing potential security risks. Set to `true` to enable; all other values are considered `false`. | Defaults to `false`. | | `NC_SANITIZE_COLUMN_NAME` | No | Enables sanitization of column names during their creation to prevent SQL injection and other security issues. | Defaults to `true`. | @@ -108,7 +108,7 @@ To update **either** `NC_ADMIN_EMAIL` or `NC_ADMIN_PASSWORD`, you must set **bot | `NC_DISABLE_PG_DATA_REFLECTION` | No | Disables the creation of a schema for each base in PostgreSQL. [Click here for more detail](#postgres-data-reflection) | Defaults to `false`. | | `NC_MIGRATIONS_DISABLED` | No | Disables NocoDB migrations. | | | `NC_DISABLE_AUDIT` | No | Disables the audit log feature. | Defaults to `false`. | -| `NC_AUTOMATION_LOG_LEVEL` | No | Configures logging levels for automation features. Possible values: `OFF`, `ERROR`, `ALL`. More details can be found under [Webhooks](/automation/webhook/create-webhook). | Defaults to `OFF`. | +| `NC_AUTOMATION_LOG_LEVEL` | No | Configures logging levels for automation features. Possible values: `OFF`, `ERROR`, `ALL`. More details can be found under [Webhooks](/docs/product-docs/automation/webhook/create-webhook). | Defaults to `OFF`. | ### Postgres Data Reflection diff --git a/content/self-hosting/upgrading.mdx b/content/self-hosting/upgrading.mdx index 7ee13e14..34f7e714 100644 --- a/content/self-hosting/upgrading.mdx +++ b/content/self-hosting/upgrading.mdx @@ -5,7 +5,7 @@ tags: ['Open Source'] keywords: ['NocoDB upgrade', 'upgrade NocoDB', 'upgrade nocodb'] --- -By default, if `NC_DB` is not specified upon [installation](/getting-started/self-hosted/installation/auto-upstall), then SQLite will be used to store metadata. We suggest users to separate the metadata and user data in different databases as pictured in our [architecture](/engineering/architecture). +By default, if `NC_DB` is not specified upon [installation](/docs/self-hosting/auto-upstall), then SQLite will be used to store metadata. We suggest users to separate the metadata and user data in different databases as pictured in our [architecture](/docs/product-docs/engineering/architecture). ## Docker