Browse Source

docs : added Upgrading.md & refactored.

Signed-off-by: Naveen MR <oof1lab@gmail.com>
pull/523/head
Naveen MR 3 years ago
parent
commit
3d79fabcdf
  1. 2
      packages/noco-docs/content/en/FAQs.md
  2. 10
      packages/noco-docs/content/en/developer-resources/AccessingAPIs.md
  3. 2
      packages/noco-docs/content/en/developer-resources/GraphqlAPIs.md
  4. 2
      packages/noco-docs/content/en/developer-resources/RestAPIs.md
  5. 10
      packages/noco-docs/content/en/developer-resources/Webhooks.md
  6. 4
      packages/noco-docs/content/en/getting-started/Demos.md
  7. 0
      packages/noco-docs/content/en/getting-started/Installation.md
  8. 53
      packages/noco-docs/content/en/getting-started/Upgrading.md
  9. 2
      packages/noco-docs/content/en/index.md
  10. 4
      packages/noco-docs/content/en/setup-and-usages/Audit.md
  11. 12
      packages/noco-docs/content/en/setup-and-usages/ColumnTypes.md
  12. 8
      packages/noco-docs/content/en/setup-and-usages/Dashboard.md
  13. 4
      packages/noco-docs/content/en/setup-and-usages/Formulas.md
  14. 10
      packages/noco-docs/content/en/setup-and-usages/MetaManagement.md
  15. 10
      packages/noco-docs/content/en/setup-and-usages/Tables.md

2
packages/noco-docs/content/en/faqs.md → packages/noco-docs/content/en/FAQs.md

@ -1,7 +1,7 @@
--- ---
title: 'FAQs' title: 'FAQs'
description: 'FAQs' description: 'FAQs'
position: 100 position: 10000
category: 'FAQ' category: 'FAQ'
fullscreen: true fullscreen: true
menuTitle: 'FAQs' menuTitle: 'FAQs'

10
packages/noco-docs/content/en/setup-and-usages/apis-access.md → packages/noco-docs/content/en/developer-resources/AccessingAPIs.md

@ -1,9 +1,9 @@
--- ---
title: 'APIs Access' title: 'How to access APIs ?'
description: 'APIs Access' description: 'How to access APIs ?'
position: 14 position: 100
category: 'Setup and Usages' category: 'Developer Resources'
menuTitle: 'APIs Access' menuTitle: 'How to access APIs ?'
--- ---
## REST APIs ## REST APIs

2
packages/noco-docs/content/en/developer-resources/graphql-apis.md → packages/noco-docs/content/en/developer-resources/GraphqlAPIs.md

@ -1,6 +1,6 @@
--- ---
title: 'GraphQL APIs' title: 'GraphQL APIs'
position: 21 position: 300
category: 'Developer Resources' category: 'Developer Resources'
menuTitle: 'GraphQL APIs' menuTitle: 'GraphQL APIs'
--- ---

2
packages/noco-docs/content/en/developer-resources/rest-apis.md → packages/noco-docs/content/en/developer-resources/RestAPIs.md

@ -1,6 +1,6 @@
--- ---
title: 'REST APIs' title: 'REST APIs'
position: 20 position: 200
category: 'Developer Resources' category: 'Developer Resources'
menuTitle: 'REST APIs' menuTitle: 'REST APIs'
--- ---

10
packages/noco-docs/content/en/setup-and-usages/api-webhooks.md → packages/noco-docs/content/en/developer-resources/Webhooks.md

@ -1,9 +1,9 @@
--- ---
title: 'API Webhooks' title: 'Webhooks'
description: 'API Webhooks' description: 'Webhooks'
position: 14 position: 400
category: 'Setup and Usages' category: 'Developer Resources'
menuTitle: 'API Webhooks' menuTitle: 'Webhooks'
--- ---

4
packages/noco-docs/content/en/getting-started/demos.md → packages/noco-docs/content/en/getting-started/Demos.md

@ -1,10 +1,12 @@
--- ---
title: 'Demos' title: 'Demos'
description: 'Demos' description: 'Demos'
position: 2 position: 3
category: 'Getting started' category: 'Getting started'
fullscreen: true fullscreen: true
menuTitle: 'Demos' menuTitle: 'Demos'
--- ---
Demos are loading from https://nocodb.com (please wait)
<iframe src="https://nocodb.com/demos" style="height:100vh" width="100%"/> <iframe src="https://nocodb.com/demos" style="height:100vh" width="100%"/>

0
packages/noco-docs/content/en/getting-started/installation.md → packages/noco-docs/content/en/getting-started/Installation.md

53
packages/noco-docs/content/en/getting-started/Upgrading.md

@ -0,0 +1,53 @@
---
title: 'Upgrading'
description: 'Upgrading NocoDB : Docker, npm, Heroku!'
position: 2
category: 'Getting started'
menuTitle: 'Upgrading'
link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark
---
## Docker
Updating nocodb docker container is similar to updating [any other docker container](https://www.whitesourcesoftware.com/free-developer-tools/blog/update-docker-images/).
Usually this involves the following
- Find the nocodb image
- Stop the nocodb docker container
- Remove the nocodb docker container
- Pull & Run the latest nocodb docker container
_*Please ensure you run latest docker container with same environment variables as before.*_
## Node
Updating docker container is similar to updating a npm package.
From your root folder
#### Uninstall nocodb package
```bash
npm uninstall nocodb
```
#### Install nocodb package
```bash
npm install --save nocodb
```
## Heroku
Use Heroku CLI login
```
heroku container:login
docker pull nocodb/nocodb:latest
docker tag nocodb/nocodb:latest registry.heroku.com/<Heroku App Name>/web
docker push registry.heroku.com/<Heroku App Name>/web
heroku container:release -a <Heroku App Name> web
```

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

@ -2,7 +2,7 @@
title: 'NocoDB Documentation' title: 'NocoDB Documentation'
description: 'NocoDB Documentation' description: 'NocoDB Documentation'
position: 0 position: 0
category: 'Getting started' category: 'Welcome'
menuTitle: 'Introduction' menuTitle: 'Introduction'
--- ---

4
packages/noco-docs/content/en/setup-and-usages/audit.md → packages/noco-docs/content/en/setup-and-usages/Audit.md

@ -1,8 +1,8 @@
--- ---
title: 'Audit' title: 'Audit'
description: 'Audit log' description: 'Audit log'
position: 13.5 position: 50
category: 'Setup and Usages' category: 'Usage'
menuTitle: 'Audit' menuTitle: 'Audit'
--- ---

12
packages/noco-docs/content/en/setup-and-usages/abstract-types.md → packages/noco-docs/content/en/setup-and-usages/ColumnTypes.md

@ -1,12 +1,12 @@
--- ---
title: 'Abstract Types' title: 'Column Types'
description: 'Abstract Types' description: 'Column Types'
position: 12 position: 30
category: 'Setup and Usages' category: 'Usage'
menuTitle: 'Abstract Types' menuTitle: 'Column Types'
--- ---
## Available Abstract Types ## Available Column Types
| Type | Description | | Type | Description |
|---|---| |---|---|

8
packages/noco-docs/content/en/setup-and-usages/nocodb-dashboard.md → packages/noco-docs/content/en/setup-and-usages/Dashboard.md

@ -1,9 +1,9 @@
--- ---
title: 'NocoDB Dashboard' title: 'Dashboard'
description: 'NocoDB Dashboard' description: 'Dashboard'
position: 10 position: 10
category: 'Setup and Usages' category: 'Usage'
menuTitle: 'NocoDB Dashboard' menuTitle: 'Dashboard'
--- ---
## Setup your first super admin ## Setup your first super admin

4
packages/noco-docs/content/en/setup-and-usages/formula.md → packages/noco-docs/content/en/setup-and-usages/Formulas.md

@ -1,8 +1,8 @@
--- ---
title: 'Formula' title: 'Formula'
description: 'Formula' description: 'Formula'
position: 13 position: 40
category: 'Setup and Usages' category: 'Usage'
menuTitle: 'Formula' menuTitle: 'Formula'
--- ---

10
packages/noco-docs/content/en/setup-and-usages/meta-management.md → packages/noco-docs/content/en/setup-and-usages/MetaManagement.md

@ -1,9 +1,9 @@
--- ---
title: 'Meta Management' title: 'Metadata'
description: 'Meta Management' description: 'Metadata'
position: 15 position: 60
category: 'Setup and Usages' category: 'Usage'
menuTitle: 'Meta Managements' menuTitle: 'Metadata'
--- ---
To go to the Meta Management Portal, click ``Project Metadata`` under ``Settings`` on the leftmost menu. To go to the Meta Management Portal, click ``Project Metadata`` under ``Settings`` on the leftmost menu.

10
packages/noco-docs/content/en/setup-and-usages/table-and-column-creation.md → packages/noco-docs/content/en/setup-and-usages/Tables.md

@ -1,9 +1,9 @@
--- ---
title: 'Table & Columns' title: 'Tables'
description: 'Table and Columns' description: 'Tables'
position: 11 position: 20
category: 'Setup and Usages' category: 'Usage'
menuTitle: 'Table and Columns' menuTitle: 'Tables'
--- ---
Loading…
Cancel
Save