Browse Source

docs: minor meta changes

pull/4461/head
Wing-Kam Wong 2 years ago
parent
commit
6e212a4d78
  1. 15
      packages/noco-docs/content/en/engineering/development-setup.md
  2. 4
      packages/noco-docs/content/en/engineering/repository-structure.md
  3. 3
      packages/noco-docs/content/en/engineering/testing.md
  4. 2
      packages/noco-docs/content/en/setup-and-usages/views.md

15
packages/noco-docs/content/en/engineering/development-setup.md

@ -1,9 +1,9 @@
---
title: "Development setup"
title: "Development Setup"
description: "How to set-up your development environment"
position: 3200
category: "Engineering"
menuTitle: "Development setup"
menuTitle: "Development Setup"
---
## Clone the repo
@ -13,6 +13,7 @@ cd nocodb/packages
```
## Build SDK
```
# build nocodb-sdk
cd nocodb-sdk
@ -21,6 +22,7 @@ npm run build
```
## Build Backend
```
# build backend - runs on port 8080
cd ../nocodb
@ -29,6 +31,7 @@ npm run watch:run
```
## Build Frontend
```
# build frontend - runs on port 3000
cd ../nc-gui
@ -38,11 +41,13 @@ npm run dev
Any changes made to frontend and backend will be automatically reflected in the browser.
## Enabling CI-CD for draft PR
## Enabling CI-CD for Draft PR
CI-CD will be triggered on moving a PR from draft state to `Ready for review` state & on pushing changes to `Develop`. To verify CI-CD before requesting for review, add label `trigger-CI` on Draft PR.
## Accessing CI-CD failure screenshots
For Cypress tests, screenshots are captured on test failure. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on `Artifacts`
## Accessing CI-CD Failure Screenshots
For Playwright tests, screenshots are captured on the tests. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on `Artifacts`
![Screenshot 2022-09-29 at 12 43 37 PM](https://user-images.githubusercontent.com/86527202/192965070-dc04b952-70fb-4197-b4bd-ca7eda066e60.png)

4
packages/noco-docs/content/en/engineering/repository-structure.md

@ -1,9 +1,9 @@
---
title: "Repository structure"
description: "Repository structure"
description: "Repository Structure"
position: 3100
category: "Engineering"
menuTitle: "Repository structure"
menuTitle: "Repository Structure"
---
We use ``Lerna`` to manage multi-packages. We have the following [packages](https://github.com/nocodb/nocodb/tree/master/packages).

3
packages/noco-docs/content/en/engineering/testing.md

@ -3,7 +3,7 @@ title: "Writing Tests"
description: "Overview to testing"
position: 3250
category: "Engineering"
menuTitle: "Testing"
menuTitle: "Writing Tests"
---
## Unit Tests
@ -36,6 +36,7 @@ Configure the following variables
> DB_PASSWORD : password </br>
### Run Tests
``` bash
npm run test:unit
```

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

@ -1,7 +1,7 @@
---
title: 'Views'
description: 'Understanding Views in NocoDB!'
position: 600
position: 700
category: 'Product'
menuTitle: 'Views'
---

Loading…
Cancel
Save