Browse Source

docs: revise / add missing descriptions

pull/2511/head
Wing-Kam Wong 3 years ago
parent
commit
3d2a9668f3
  1. 3
      packages/noco-docs/content/en/FAQs.md
  2. 2
      packages/noco-docs/content/en/developer-resources/accessing-apis.md
  3. 1
      packages/noco-docs/content/en/developer-resources/rest-apis.md
  4. 2
      packages/noco-docs/content/en/developer-resources/sdk.md
  5. 2
      packages/noco-docs/content/en/developer-resources/webhooks.md
  6. 2
      packages/noco-docs/content/en/engineering/architecture.md
  7. 2
      packages/noco-docs/content/en/engineering/repository-structure.md
  8. 2
      packages/noco-docs/content/en/engineering/timely-build.md
  9. 2
      packages/noco-docs/content/en/engineering/translation.md
  10. 2
      packages/noco-docs/content/en/getting-started/demos.md
  11. 2
      packages/noco-docs/content/en/getting-started/installation.md
  12. 4
      packages/noco-docs/content/en/getting-started/upgrading.md
  13. 9
      packages/noco-docs/content/en/index.md
  14. 2
      packages/noco-docs/content/en/setup-and-usages/app-store.md
  15. 2
      packages/noco-docs/content/en/setup-and-usages/audit.md
  16. 2
      packages/noco-docs/content/en/setup-and-usages/code-snippets.md
  17. 2
      packages/noco-docs/content/en/setup-and-usages/column-operations.md
  18. 2
      packages/noco-docs/content/en/setup-and-usages/column-types.md
  19. 2
      packages/noco-docs/content/en/setup-and-usages/dashboard.md
  20. 2
      packages/noco-docs/content/en/setup-and-usages/formulas.md
  21. 2
      packages/noco-docs/content/en/setup-and-usages/import-airtable-to-sql-database-within-a-minute-for-free.md
  22. 2
      packages/noco-docs/content/en/setup-and-usages/languages.md
  23. 2
      packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md
  24. 2
      packages/noco-docs/content/en/setup-and-usages/lookup.md
  25. 2
      packages/noco-docs/content/en/setup-and-usages/meta-management.md
  26. 2
      packages/noco-docs/content/en/setup-and-usages/primary-key.md
  27. 2
      packages/noco-docs/content/en/setup-and-usages/primary-value.md
  28. 2
      packages/noco-docs/content/en/setup-and-usages/rollup.md
  29. 2
      packages/noco-docs/content/en/setup-and-usages/share-base.md
  30. 2
      packages/noco-docs/content/en/setup-and-usages/share-view.md
  31. 2
      packages/noco-docs/content/en/setup-and-usages/sync-schema.md
  32. 2
      packages/noco-docs/content/en/setup-and-usages/table-operations.md
  33. 1
      packages/noco-docs/content/en/setup-and-usages/team-and-auth.md
  34. 2
      packages/noco-docs/content/en/setup-and-usages/usage-information.md
  35. 2
      packages/noco-docs/content/en/setup-and-usages/views.md

3
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

2
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'

1
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'

2
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'

2
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"

2
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"

2
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"

2
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"

2
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"

2
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

2
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

4
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

9
packages/noco-docs/content/en/index.md

@ -6,11 +6,6 @@ category: 'Welcome'
menuTitle: 'Introduction'
---
<alert type="warning">
This documentation is only for version 0.90 onwards. If you are looking for the previous versions, please check out
<a href="https://docs-prev.nocodb.com/" target="_blank">here</a>.
</alert>
## 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).

2
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'

2
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'

2
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'

2
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"

2
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'

2
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'

2
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"

2
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'

2
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'

2
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"

2
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"

2
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'

2
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"

2
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"

2
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"

2
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"

2
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"

2
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'

2
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"

1
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)

2
packages/noco-docs/content/en/setup-and-usages/usage-information.md

@ -6,8 +6,6 @@ category: 'Product'
menuTitle: 'Usage Information'
---
<announcement></announcement>
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.

2
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'

Loading…
Cancel
Save