Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(nms): Align read-me with markdown linter #13225

Merged
merged 2 commits into from
Jul 11, 2022
Merged

fix(nms): Align read-me with markdown linter #13225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ceeb20
fix(nms): Align read-me with markdown linter
Neudrino Jul 7, 2022
b645a49
docs: fix typo for nms
Neudrino Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/readmes/nms/dev_testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ These are the set of tests that you should run before opening a pull request.

#### Eslint

Run `yarn run eslint .` to test that there are no linter errors. You can also run `yarn run eslint --fix .` to fix automatically fixable linter errors.
Run `yarn run eslint .` to test that there are no linter errors. You can also run `yarn run eslint --fix .` to fix automatically-fixable linter errors.

#### TypeScript

Expand Down
9 changes: 9 additions & 0 deletions nms/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Here, `package.json` specifies the necessary dependencies and development script
Triggering unit tests, e2e tests, eslint, and TypeScript checks is done from this directory.

---

## Running Local Dev NMS

> NOTE: This guide is written for development directly using Docker.
> You may need to make adjustments if using MiniKube.

Expand Down Expand Up @@ -113,9 +115,11 @@ This likely corresponds to React errors.
If this is the case, you should be able to see the relevant error logs through your web browser's developer tools.

---

## Testing

### Install Dependencies

Running eslint and TypeScript checks requires installing dependencies.

Install node and npm if you haven't already
Expand All @@ -138,8 +142,10 @@ yarn run eslint ./
```

### TypeScript

Run from [`nms/`](../nms/).
Version `4.7.4` of `TypeScript` is used currently.

```
yarn run tsc
```
Expand Down Expand Up @@ -169,14 +175,17 @@ yarn test:e2e
Run `yarn test --coverage`

---

## Updating NMS for API Changes

### How to re-generate TypeScript API bindings

Run `./build.py --generate` in `${MAGMA_ROOT}/orc8r/cloud/docker`

This re-generates various files, including the TypeScript API bindings for NMS.

---

## Accessing Local Dev NMS

### Multitenancy and Organizations
Expand Down