From 3d2a9668f3606d6ee887a8f8ac4939f36119dde1 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Thu, 30 Jun 2022 12:57:10 +0800 Subject: [PATCH] docs: revise / add missing descriptions --- packages/noco-docs/content/en/FAQs.md | 3 +-- .../content/en/developer-resources/accessing-apis.md | 2 +- .../content/en/developer-resources/rest-apis.md | 1 + packages/noco-docs/content/en/developer-resources/sdk.md | 2 +- .../noco-docs/content/en/developer-resources/webhooks.md | 2 +- .../noco-docs/content/en/engineering/architecture.md | 2 +- .../content/en/engineering/repository-structure.md | 2 +- .../noco-docs/content/en/engineering/timely-build.md | 2 +- packages/noco-docs/content/en/engineering/translation.md | 2 +- packages/noco-docs/content/en/getting-started/demos.md | 2 +- .../noco-docs/content/en/getting-started/installation.md | 2 -- .../noco-docs/content/en/getting-started/upgrading.md | 4 ++-- packages/noco-docs/content/en/index.md | 9 ++------- .../noco-docs/content/en/setup-and-usages/app-store.md | 2 +- packages/noco-docs/content/en/setup-and-usages/audit.md | 2 +- .../content/en/setup-and-usages/code-snippets.md | 2 +- .../content/en/setup-and-usages/column-operations.md | 2 +- .../content/en/setup-and-usages/column-types.md | 2 +- .../noco-docs/content/en/setup-and-usages/dashboard.md | 2 +- .../noco-docs/content/en/setup-and-usages/formulas.md | 2 +- ...-airtable-to-sql-database-within-a-minute-for-free.md | 2 +- .../noco-docs/content/en/setup-and-usages/languages.md | 2 +- .../en/setup-and-usages/link-to-another-record.md | 2 +- packages/noco-docs/content/en/setup-and-usages/lookup.md | 2 +- .../content/en/setup-and-usages/meta-management.md | 2 +- .../noco-docs/content/en/setup-and-usages/primary-key.md | 2 +- .../content/en/setup-and-usages/primary-value.md | 2 +- packages/noco-docs/content/en/setup-and-usages/rollup.md | 2 +- .../noco-docs/content/en/setup-and-usages/share-base.md | 2 +- .../noco-docs/content/en/setup-and-usages/share-view.md | 2 +- .../noco-docs/content/en/setup-and-usages/sync-schema.md | 2 +- .../content/en/setup-and-usages/table-operations.md | 2 +- .../content/en/setup-and-usages/team-and-auth.md | 1 - .../content/en/setup-and-usages/usage-information.md | 2 -- packages/noco-docs/content/en/setup-and-usages/views.md | 2 +- 35 files changed, 34 insertions(+), 44 deletions(-) diff --git a/packages/noco-docs/content/en/FAQs.md b/packages/noco-docs/content/en/FAQs.md index 88480d20a8..b35fdae607 100644 --- a/packages/noco-docs/content/en/FAQs.md +++ b/packages/noco-docs/content/en/FAQs.md @@ -1,6 +1,6 @@ --- title: 'FAQs' -description: 'FAQs' +description: 'General FAQs' position: 1000000 category: 'FAQ' menuTitle: 'FAQs' @@ -65,7 +65,6 @@ Auth Token is a JWT Token generated based on the logged-in user. By default, the API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called `xc-token`. - ## Do you plan to have Enterprise Edition ? For features that make sense for enterprises like below - yes diff --git a/packages/noco-docs/content/en/developer-resources/accessing-apis.md b/packages/noco-docs/content/en/developer-resources/accessing-apis.md index f2dbe3e1b0..15c8565c04 100644 --- a/packages/noco-docs/content/en/developer-resources/accessing-apis.md +++ b/packages/noco-docs/content/en/developer-resources/accessing-apis.md @@ -1,6 +1,6 @@ --- title: 'Accessing APIs' -description: 'Accessing APIs' +description: 'How to access NocoDB APIs with Auth or API token?' position: 1000 category: 'Developer Resources' menuTitle: 'Accessing APIs' diff --git a/packages/noco-docs/content/en/developer-resources/rest-apis.md b/packages/noco-docs/content/en/developer-resources/rest-apis.md index 72bdeb470c..2654df87e1 100644 --- a/packages/noco-docs/content/en/developer-resources/rest-apis.md +++ b/packages/noco-docs/content/en/developer-resources/rest-apis.md @@ -1,5 +1,6 @@ --- title: 'REST APIs' +description: 'NocoDB REST API Overview' position: 1010 category: 'Developer Resources' menuTitle: 'REST APIs' diff --git a/packages/noco-docs/content/en/developer-resources/sdk.md b/packages/noco-docs/content/en/developer-resources/sdk.md index b28337202b..53a5efee91 100644 --- a/packages/noco-docs/content/en/developer-resources/sdk.md +++ b/packages/noco-docs/content/en/developer-resources/sdk.md @@ -1,6 +1,6 @@ --- title: 'NocoDB SDK' -description: 'SDK' +description: 'NocoDB SDK Overview' position: 1400 category: 'Developer Resources' menuTitle: 'NocoDB SDK' diff --git a/packages/noco-docs/content/en/developer-resources/webhooks.md b/packages/noco-docs/content/en/developer-resources/webhooks.md index 4c49e15ed6..d95e1bf68d 100644 --- a/packages/noco-docs/content/en/developer-resources/webhooks.md +++ b/packages/noco-docs/content/en/developer-resources/webhooks.md @@ -1,6 +1,6 @@ --- title: "Webhooks" -description: "Webhooks" +description: "Webhooks allows user to trigger on certain operations on following database operations" position: 1500 category: "Developer Resources" menuTitle: "Webhooks" diff --git a/packages/noco-docs/content/en/engineering/architecture.md b/packages/noco-docs/content/en/engineering/architecture.md index 737514ff37..29cb3c0769 100644 --- a/packages/noco-docs/content/en/engineering/architecture.md +++ b/packages/noco-docs/content/en/engineering/architecture.md @@ -1,6 +1,6 @@ --- title: "NocoDB Architecture" -description: "NocoDB Architecture" +description: "NocoDB Architecture Overview" position: 4000 category: "Engineering" menuTitle: "NocoDB Architecture" diff --git a/packages/noco-docs/content/en/engineering/repository-structure.md b/packages/noco-docs/content/en/engineering/repository-structure.md index c88453d020..daa573bd32 100644 --- a/packages/noco-docs/content/en/engineering/repository-structure.md +++ b/packages/noco-docs/content/en/engineering/repository-structure.md @@ -1,6 +1,6 @@ --- title: "Repository Structure" -description: "Repository Structure" +description: "NocoDB Repository Structure Overview" position: 3000 category: "Engineering" menuTitle: "Repository Structure" diff --git a/packages/noco-docs/content/en/engineering/timely-build.md b/packages/noco-docs/content/en/engineering/timely-build.md index 55e404c505..9e1692a196 100644 --- a/packages/noco-docs/content/en/engineering/timely-build.md +++ b/packages/noco-docs/content/en/engineering/timely-build.md @@ -1,6 +1,6 @@ --- title: "Timely Build" -description: "Timely Build" +description: "NocoDB provides Timely Build for Docker and Binary Executables" position: 5000 category: "Engineering" menuTitle: "Timely Build" diff --git a/packages/noco-docs/content/en/engineering/translation.md b/packages/noco-docs/content/en/engineering/translation.md index afaa686a11..4473eff4c3 100644 --- a/packages/noco-docs/content/en/engineering/translation.md +++ b/packages/noco-docs/content/en/engineering/translation.md @@ -1,6 +1,6 @@ --- title: "i18n" -description: "Contribute to NocoDB's i18n translation" +description: "How to contribute to NocoDB's i18n translation?" position: 2000 category: "Engineering" menuTitle: "i18n" diff --git a/packages/noco-docs/content/en/getting-started/demos.md b/packages/noco-docs/content/en/getting-started/demos.md index 236ce59012..a3fa06256e 100644 --- a/packages/noco-docs/content/en/getting-started/demos.md +++ b/packages/noco-docs/content/en/getting-started/demos.md @@ -1,6 +1,6 @@ --- title: 'Demos' -description: 'Demos' +description: 'NocoDB Demos' position: 30 category: 'Getting started' fullscreen: true diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index 2e2e9f7d96..9c99de35d0 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -20,7 +20,6 @@ Simple installation - takes about three minutes! ## Quick try - ### 1-Click Deploy to Heroku Before doing so, make sure you have a Heroku account. By default, an add-on Heroku Postgres will be used as meta database. You can see the connection string defined in `DATABASE_URL` by navigating to Heroku App Settings and selecting Config Vars. @@ -86,7 +85,6 @@ curl http://get.nocodb.com/macos-arm64 -o nocodb -L \ && ./nocodb ``` - ##### Linux (x64) ```bash diff --git a/packages/noco-docs/content/en/getting-started/upgrading.md b/packages/noco-docs/content/en/getting-started/upgrading.md index 2bb13f52d1..e1f6d75685 100644 --- a/packages/noco-docs/content/en/getting-started/upgrading.md +++ b/packages/noco-docs/content/en/getting-started/upgrading.md @@ -1,6 +1,6 @@ --- title: 'Upgrading' -description: 'Upgrading NocoDB : Docker, npm, Heroku!' +description: 'Upgrading NocoDB : Docker, Node, Heroku and Homebrew!' position: 20 category: 'Getting started' menuTitle: 'Upgrading' @@ -100,7 +100,7 @@ This will trigger the Heroku deployment. Your app should now be updated to the l ## Homebrew -Run following commands to upgrade Homebrew Noocodb version. +Run following commands to upgrade Homebrew Nocodb version. ```bash # Update the local homebrew formulas diff --git a/packages/noco-docs/content/en/index.md b/packages/noco-docs/content/en/index.md index a0914655af..e59c642204 100644 --- a/packages/noco-docs/content/en/index.md +++ b/packages/noco-docs/content/en/index.md @@ -6,11 +6,6 @@ category: 'Welcome' menuTitle: 'Introduction' --- - - This documentation is only for version 0.90 onwards. If you are looking for the previous versions, please check out - here. - - ## Welcome! NocoDB is a no-code database platform that allows teams to collaborate and build applications with ease of a familiar and intuitive spreadsheet interface. This allows even non-developers or business users to become software creators. @@ -97,8 +92,8 @@ We encourage all contributors to commit messages following [Commit Message Conve We require a CLA (Contributor License Agreement). This is a one-time process. Please click this [link](https://cla-assistant.io/nocodb/nocodb) to agree to the CLA for nocodb/nocodb. -You can also share your thoughts and discuss with our community members via [discord](https://discord.gg/5RgZmkW) or [Github Discussion](https://github.com/nocodb/nocodb/discussions). We also share our [Immediate Roadmap](https://github.com/nocodb/nocodb/projects/1) and all opinions are welcome. +You can also share your thoughts and discuss with our community members via [Discord](https://discord.gg/5RgZmkW) or [Github Discussion](https://github.com/nocodb/nocodb/discussions). We also share our [Immediate Roadmap](https://github.com/nocodb/nocodb/projects/1) and all opinions are welcome. ## Support -If you have any issues or questions, you can reach out for help in our [discord](https://discord.gg/5RgZmkW). +If you have any issues or questions, you can reach out for help in our [Discord](https://discord.gg/5RgZmkW). diff --git a/packages/noco-docs/content/en/setup-and-usages/app-store.md b/packages/noco-docs/content/en/setup-and-usages/app-store.md index b0fba0d8a6..f0b518ed35 100644 --- a/packages/noco-docs/content/en/setup-and-usages/app-store.md +++ b/packages/noco-docs/content/en/setup-and-usages/app-store.md @@ -1,6 +1,6 @@ --- title: 'App Store' -description: 'App Store' +description: 'NocoDB provides different integrations in three main categories in App Store' position: 1100 category: 'Product' menuTitle: 'App Store' diff --git a/packages/noco-docs/content/en/setup-and-usages/audit.md b/packages/noco-docs/content/en/setup-and-usages/audit.md index 7e24860ee1..39b513c6c3 100644 --- a/packages/noco-docs/content/en/setup-and-usages/audit.md +++ b/packages/noco-docs/content/en/setup-and-usages/audit.md @@ -1,6 +1,6 @@ --- title: 'Audit' -description: 'Audit log' +description: 'NocoDB provides all the user operation logs under Audit log' position: 590 category: 'Product' menuTitle: 'Audit' diff --git a/packages/noco-docs/content/en/setup-and-usages/code-snippets.md b/packages/noco-docs/content/en/setup-and-usages/code-snippets.md index ec6671c36a..479f98b6b5 100644 --- a/packages/noco-docs/content/en/setup-and-usages/code-snippets.md +++ b/packages/noco-docs/content/en/setup-and-usages/code-snippets.md @@ -1,6 +1,6 @@ --- title: 'Code Snippets' -description: 'Code Snippets' +description: 'Code Snippets Examples in different ways' position: 540 category: 'Product' menuTitle: 'Code Snippets' diff --git a/packages/noco-docs/content/en/setup-and-usages/column-operations.md b/packages/noco-docs/content/en/setup-and-usages/column-operations.md index 56977d1515..167f9a7226 100644 --- a/packages/noco-docs/content/en/setup-and-usages/column-operations.md +++ b/packages/noco-docs/content/en/setup-and-usages/column-operations.md @@ -1,6 +1,6 @@ --- title: "Column Operations" -description: "Column Operations" +description: "Column Operations: Fields, Sort & Filter" position: 520 category: "Product" menuTitle: "Column Operations" diff --git a/packages/noco-docs/content/en/setup-and-usages/column-types.md b/packages/noco-docs/content/en/setup-and-usages/column-types.md index 2e43e5de61..bf3f41cac2 100644 --- a/packages/noco-docs/content/en/setup-and-usages/column-types.md +++ b/packages/noco-docs/content/en/setup-and-usages/column-types.md @@ -1,6 +1,6 @@ --- title: 'Column Types' -description: 'Column Types' +description: 'NocoDB Column Types Overview' position: 530 category: 'Product' menuTitle: 'Column Types' diff --git a/packages/noco-docs/content/en/setup-and-usages/dashboard.md b/packages/noco-docs/content/en/setup-and-usages/dashboard.md index 6a77d03419..21bcbd1aec 100644 --- a/packages/noco-docs/content/en/setup-and-usages/dashboard.md +++ b/packages/noco-docs/content/en/setup-and-usages/dashboard.md @@ -1,6 +1,6 @@ --- title: 'Dashboard' -description: 'Dashboard' +description: 'Accessing the Dashboard!' position: 500 category: 'Product' menuTitle: 'Dashboard' diff --git a/packages/noco-docs/content/en/setup-and-usages/formulas.md b/packages/noco-docs/content/en/setup-and-usages/formulas.md index c933063622..53044134a6 100644 --- a/packages/noco-docs/content/en/setup-and-usages/formulas.md +++ b/packages/noco-docs/content/en/setup-and-usages/formulas.md @@ -1,6 +1,6 @@ --- title: "Formulas" -description: "Formulas" +description: "NocoDB Formulas Syntaxes and Functions" position: 570 category: "Product" menuTitle: "Formulas" diff --git a/packages/noco-docs/content/en/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free.md b/packages/noco-docs/content/en/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free.md index c2100a6289..e4f2a77913 100644 --- a/packages/noco-docs/content/en/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free.md +++ b/packages/noco-docs/content/en/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free.md @@ -1,6 +1,6 @@ --- title: 'Import Airtable to NocoDB' -description: 'Import Airtable to NocoDB' +description: 'A complete import of your Airtable to any MySQL, Postgres, SQLite and SQL server databases within minutes' position: 1150 category: 'Product' menuTitle: 'Import Airtable to NocoDB' diff --git a/packages/noco-docs/content/en/setup-and-usages/languages.md b/packages/noco-docs/content/en/setup-and-usages/languages.md index 3c2ff98223..5711e30b91 100644 --- a/packages/noco-docs/content/en/setup-and-usages/languages.md +++ b/packages/noco-docs/content/en/setup-and-usages/languages.md @@ -1,6 +1,6 @@ --- title: 'Languages' -description: 'Languages' +description: 'Multiple languages on Dashboard!' position: 900 category: 'Product' menuTitle: 'Languages' diff --git a/packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md b/packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md index 7049b9bd52..f1980ba5d6 100644 --- a/packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md +++ b/packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md @@ -1,6 +1,6 @@ --- title: "Link To Another Record" -description: "Link To Another Record" +description: "Understanding Link To Another Record (LTAR) Columns!" position: 540 category: "Product" menuTitle: "Link To Another Record" diff --git a/packages/noco-docs/content/en/setup-and-usages/lookup.md b/packages/noco-docs/content/en/setup-and-usages/lookup.md index 4bef37c59b..f4748984a4 100644 --- a/packages/noco-docs/content/en/setup-and-usages/lookup.md +++ b/packages/noco-docs/content/en/setup-and-usages/lookup.md @@ -1,6 +1,6 @@ --- title: "Lookup" -description: "Lookup" +description: "Understanding Lookup Column!" position: 550 category: "Product" menuTitle: "Lookup" diff --git a/packages/noco-docs/content/en/setup-and-usages/meta-management.md b/packages/noco-docs/content/en/setup-and-usages/meta-management.md index 0afe7d5711..38eb3f518b 100644 --- a/packages/noco-docs/content/en/setup-and-usages/meta-management.md +++ b/packages/noco-docs/content/en/setup-and-usages/meta-management.md @@ -1,6 +1,6 @@ --- title: 'Metadata' -description: 'Metadata' +description: 'NocoDB Project Metadata' position: 600 category: 'Product' menuTitle: 'Metadata' diff --git a/packages/noco-docs/content/en/setup-and-usages/primary-key.md b/packages/noco-docs/content/en/setup-and-usages/primary-key.md index 1bcb66c153..62112ae834 100644 --- a/packages/noco-docs/content/en/setup-and-usages/primary-key.md +++ b/packages/noco-docs/content/en/setup-and-usages/primary-key.md @@ -1,6 +1,6 @@ --- title: "Primary Key" -description: "Primary Key" +description: "Understanding Primary Key in NocoDB!" position: 575 category: "Product" menuTitle: "Primary Key" diff --git a/packages/noco-docs/content/en/setup-and-usages/primary-value.md b/packages/noco-docs/content/en/setup-and-usages/primary-value.md index 2b448c48fd..e42de05e51 100644 --- a/packages/noco-docs/content/en/setup-and-usages/primary-value.md +++ b/packages/noco-docs/content/en/setup-and-usages/primary-value.md @@ -1,6 +1,6 @@ --- title: "Primary value" -description: "Primary value" +description: "Understanding Primary Value in NocoDB!" position: 580 category: "Product" menuTitle: "Primary value" diff --git a/packages/noco-docs/content/en/setup-and-usages/rollup.md b/packages/noco-docs/content/en/setup-and-usages/rollup.md index f3d04f5d69..01d1e6dee5 100644 --- a/packages/noco-docs/content/en/setup-and-usages/rollup.md +++ b/packages/noco-docs/content/en/setup-and-usages/rollup.md @@ -1,6 +1,6 @@ --- title: "Rollup" -description: "Rollup" +description: "Understanding Rollup Column!" position: 560 category: "Product" menuTitle: "Rollup" diff --git a/packages/noco-docs/content/en/setup-and-usages/share-base.md b/packages/noco-docs/content/en/setup-and-usages/share-base.md index 608df68aa0..366077f91b 100644 --- a/packages/noco-docs/content/en/setup-and-usages/share-base.md +++ b/packages/noco-docs/content/en/setup-and-usages/share-base.md @@ -1,6 +1,6 @@ --- title: "Share Base" -description: "Procedure to share a base & generating embedded iframe" +description: "Procedures to share a base & generating embedded iframe" position: 615 category: "Product" menuTitle: "Share Base" diff --git a/packages/noco-docs/content/en/setup-and-usages/share-view.md b/packages/noco-docs/content/en/setup-and-usages/share-view.md index 36f212c7d2..79f99e7d00 100644 --- a/packages/noco-docs/content/en/setup-and-usages/share-view.md +++ b/packages/noco-docs/content/en/setup-and-usages/share-view.md @@ -1,6 +1,6 @@ --- title: "Share View" -description: "Procedure to share a view" +description: "Procedures to share a view" position: 620 category: "Product" menuTitle: "Share View" diff --git a/packages/noco-docs/content/en/setup-and-usages/sync-schema.md b/packages/noco-docs/content/en/setup-and-usages/sync-schema.md index 70fef0d47e..e1db6d6459 100644 --- a/packages/noco-docs/content/en/setup-and-usages/sync-schema.md +++ b/packages/noco-docs/content/en/setup-and-usages/sync-schema.md @@ -1,6 +1,6 @@ --- title: 'Sync Schema' -description: 'Schema changes made to database from outside nocodb GUI can be synced' +description: 'Schema changes made to database from outside NocoDB GUI can be synced' position: 610 category: 'Product' menuTitle: 'Sync Schema' diff --git a/packages/noco-docs/content/en/setup-and-usages/table-operations.md b/packages/noco-docs/content/en/setup-and-usages/table-operations.md index 436251f281..730b0bc94f 100644 --- a/packages/noco-docs/content/en/setup-and-usages/table-operations.md +++ b/packages/noco-docs/content/en/setup-and-usages/table-operations.md @@ -1,6 +1,6 @@ --- title: "Table Operations" -description: "Table Operations" +description: "Table Operations: Row, Column, Quick Import, Export & Import" position: 510 category: "Product" menuTitle: "Table Operations" diff --git a/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md b/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md index 53c33fc36d..22cf8c33b7 100644 --- a/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md +++ b/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md @@ -6,7 +6,6 @@ category: 'Product' menuTitle: 'Team & Auth' --- - Team & Auth can be found by clicking `Team & Settings` from the left navigation drawer and clicking `Team & Auth`. ![image](https://user-images.githubusercontent.com/35857179/161902474-fd06678c-a171-4237-b171-dc028b3753de.png) diff --git a/packages/noco-docs/content/en/setup-and-usages/usage-information.md b/packages/noco-docs/content/en/setup-and-usages/usage-information.md index 5da170d409..3d98441e4c 100644 --- a/packages/noco-docs/content/en/setup-and-usages/usage-information.md +++ b/packages/noco-docs/content/en/setup-and-usages/usage-information.md @@ -6,8 +6,6 @@ category: 'Product' menuTitle: 'Usage Information' --- - - NocoDB is a fast growing open source project which is UI heavy and we are committed to providing a solution that exceeds the expectations of the users and community. We are also committed to continuing to develop and make NocoDB even better than it is today. To that end, NocoDB contains a feature in which anonymous and otherwise non-sensitive data is collected. diff --git a/packages/noco-docs/content/en/setup-and-usages/views.md b/packages/noco-docs/content/en/setup-and-usages/views.md index 73c3075d0b..c003d4bd99 100644 --- a/packages/noco-docs/content/en/setup-and-usages/views.md +++ b/packages/noco-docs/content/en/setup-and-usages/views.md @@ -1,6 +1,6 @@ --- title: 'Views' -description: 'Views' +description: 'Understanding Views in NocoDB!' position: 600 category: 'Product' menuTitle: 'Views'