From 0f0419f8401c9cfca195aab5a1a211b3785a1b4e Mon Sep 17 00:00:00 2001 From: Anand Tiwary <52081890+anandtiwary@users.noreply.github.com> Date: Mon, 10 May 2021 09:35:37 -0700 Subject: [PATCH 1/2] Create ONBOARDING.md --- ONBOARDING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 ONBOARDING.md diff --git a/ONBOARDING.md b/ONBOARDING.md new file mode 100644 index 000000000..7ed095641 --- /dev/null +++ b/ONBOARDING.md @@ -0,0 +1,38 @@ +# UI Onboarding + +This documents contains the onboarding guide for hypertrace-ui. + +- [Fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) + +- Tools Setup: + - [Node and Npm](https://www.npmjs.com/get-npm) + +- Techologies Used + 1. [Angular](https://angular.io/docs) + 2. [Typescript 4.x](https://www.typescriptlang.org/docs/) + 3. [Angular Testing with Spectator](https://github.com/ngneat/spectator) + - Policy around testing. + - Unit tests: Component test and service test + - Shallow test + - CodeCov requirements + - Tools used: + Jest, vscode-jest and wallabyjs + 4. [Rxjs](https://rxjs.dev/guide/overview/) + 5. [D3Js](https://github.com/d3/d3/wiki) + +- Libraries Used + - [Hyperdash](https://github.com/hypertrace/hyperdash/blob/main/README.md) + - [Hyperdash angular](https://github.com/hypertrace/hyperdash-angular/blob/main/README.md) + - [Assets-Library](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/assets-library) + - [Common](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/common) + - [Components](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/components) + - [Dashboards](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/dashboards) + - [Distributed Tracing](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/distributed-tracing) + - [Observability](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/observability) + +- [Hypertrace ui app](https://github.com/hypertrace/hypertrace-ui/tree/main/src) + +- Hyperdash and writing config driven UI + + +[^1]: More to be added soon. From 4d6b18b84aad5af3270b50b4458d39bca53d5781 Mon Sep 17 00:00:00 2001 From: anandtiwary <52081890+anandtiwary@users.noreply.github.com> Date: Tue, 11 May 2021 14:19:52 -0700 Subject: [PATCH 2/2] refactor: fixing formatting --- ONBOARDING.md | 54 ++++++++++++++++++++++++--------------------------- 1 file changed, 25 insertions(+), 29 deletions(-) diff --git a/ONBOARDING.md b/ONBOARDING.md index 7ed095641..c44fd7a2d 100644 --- a/ONBOARDING.md +++ b/ONBOARDING.md @@ -1,38 +1,34 @@ # UI Onboarding -This documents contains the onboarding guide for hypertrace-ui. +This documents contains the onboarding guide for hypertrace-ui. - [Fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) - -- Tools Setup: - - [Node and Npm](https://www.npmjs.com/get-npm) - +- Tools Setup: + - [Node and Npm](https://www.npmjs.com/get-npm) - Techologies Used - 1. [Angular](https://angular.io/docs) - 2. [Typescript 4.x](https://www.typescriptlang.org/docs/) - 3. [Angular Testing with Spectator](https://github.com/ngneat/spectator) - - Policy around testing. - - Unit tests: Component test and service test - - Shallow test - - CodeCov requirements - - Tools used: - Jest, vscode-jest and wallabyjs - 4. [Rxjs](https://rxjs.dev/guide/overview/) - 5. [D3Js](https://github.com/d3/d3/wiki) - -- Libraries Used - - [Hyperdash](https://github.com/hypertrace/hyperdash/blob/main/README.md) - - [Hyperdash angular](https://github.com/hypertrace/hyperdash-angular/blob/main/README.md) - - [Assets-Library](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/assets-library) - - [Common](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/common) - - [Components](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/components) - - [Dashboards](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/dashboards) - - [Distributed Tracing](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/distributed-tracing) - - [Observability](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/observability) + 1. [Angular](https://angular.io/docs) + 2. [Typescript 4.x](https://www.typescriptlang.org/docs/) + 3. [Angular Testing with Spectator](https://github.com/ngneat/spectator) + - Policy around testing. + - Unit tests: Component test and service test + - Shallow test + - CodeCov requirements + - Tools used: + Jest, vscode-jest and wallabyjs + 4. [Rxjs](https://rxjs.dev/guide/overview/) + 5. [D3Js](https://github.com/d3/d3/wiki) +- Libraries Used + + - [Hyperdash](https://github.com/hypertrace/hyperdash/blob/main/README.md) + - [Hyperdash angular](https://github.com/hypertrace/hyperdash-angular/blob/main/README.md) + - [Assets-Library](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/assets-library) + - [Common](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/common) + - [Components](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/components) + - [Dashboards](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/dashboards) + - [Distributed Tracing](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/distributed-tracing) + - [Observability](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/observability) - [Hypertrace ui app](https://github.com/hypertrace/hypertrace-ui/tree/main/src) - - Hyperdash and writing config driven UI - -[^1]: More to be added soon. +[^1]: More to be added soon.