[VL-62] Improve documentation #30

kin0992 · 2022-09-15T09:00:09Z

Improve README by adding more information on how to run the project locally, both using Node and Docker.

Types of changes

Chore (nothing changes by a user perspective)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.

kin0992 · 2022-09-15T09:01:31Z

A note on this PR: the repo name in the commands is still the old one, with the poc suffix.
Ref: #28 (comment)

README.md

Co-authored-by: AF <4775679+datalek@users.noreply.github.com>

datalek

Yo!

gunzip

I'll try to be more concise since devs doesn't like reading too much. Some comments are self-explanatory so they can be deleted as well.

gunzip · 2022-09-15T11:02:37Z

README.md

+This project runs using [Node.js](https://nodejs.org/en/). It is possible to see the version of Node.js used in the [`.node_version`](.node-version) file.
+You should download the version specified in that file to be sure to have the same environment as the one used by the developers.
+
+A fancy tool that can help you to manage multiple versions of Node.js is [nvm](https://github.com/nvm-sh/nvm).
+In case you want to use it, after installing it, you can run the following command to install the correct version of Node.js:


I'd replace this with "install nvm" with a link

gunzip · 2022-09-15T11:03:15Z

README.md

+```
+and after the installation has been completed, run the following command to make sure you are using the proper version of Node.js:
+
+```shell


Suggested change

```

and after the installation has been completed, run the following command to make sure you are using the proper version of Node.js:

```shell

gunzip · 2022-09-15T11:03:38Z

README.md

 ```
+Make sure that the path of `.node_version` is correct, because the example commands assumes you are in the repository folder.


Suggested change

Make sure that the path of `.node_version` is correct, because the example commands assumes you are in the repository folder.

gunzip · 2022-09-15T11:04:27Z

README.md


-``` sh
-# if needed run generate
+Before running the project, you should install the dependencies using the following command:


Suggested change

Before running the project, you should install the dependencies using the following command:

gunzip · 2022-09-15T11:05:18Z

README.md

+```
+
+After that, the project requires some code that is going to be generated starting from the [OpenAPI](./openapi/index.yaml) specification.  
+You can accomplish that by running:
+
+```shell


Suggested change

```

After that, the project requires some code that is going to be generated starting from the [OpenAPI](./openapi/index.yaml) specification.

You can accomplish that by running:

```shell

gunzip · 2022-09-15T11:06:00Z

README.md

+```

+Now, you are ready to run the project using the following command:
+
+```shell
 # start the application


Suggested change

```

Now, you are ready to run the project using the following command:

```shell

# start the application

gunzip · 2022-09-15T11:06:52Z

README.md

+
+### Run using the public container image
+
+Another option is to run the container image availeble in the container registry.


Suggested change

Another option is to run the container image availeble in the container registry.

Another option is to run the container image available in the container registry.

gunzip · 2022-09-15T11:07:30Z

README.md

+First, pull the image:
+
+```shell
+docker pull ghcr.io/pagopa/pn-local-emulator-poc:latest
+```


Suggested change

First, pull the image:

```shell

docker pull ghcr.io/pagopa/pn-local-emulator-poc:latest

```

```shell

docker pull ghcr.io/pagopa/pn-local-emulator-poc:latest

gunzip · 2022-09-15T11:07:41Z

README.md

+Then, run the application:
+
+```shell


Suggested change

Then, run the application:

```shell

gunzip · 2022-09-15T11:08:04Z

README.md


-``` sh
+## Examples


examples of... ?

lordkada · 2022-09-15T12:33:28Z

Prerequisites are not needed if the image is pulled from the registry. I think we should make it clear.

kin0992 · 2022-09-15T14:00:15Z

I've changed the documentation after the feedback. @lordkada do you think now it is clear enough that the prerequisites are not mandatory in case of pulling the image from the container registry?

lordkada · 2022-09-16T07:59:38Z

@kin0992 yep, I think it is clear enough now. Thx!

kin0992 · 2022-09-16T09:23:10Z

A note on this PR: the repo name in the commands is still the old one, with the poc suffix.
Ref: #28 (comment)

The repository has been renamed to pn-local-emulator

* generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests * first basic code handling for notification delete * update package.json * eslint fix * added .use in application.ts * merge main from features/2.0/main (#14) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * merge main from features/2.0/main (#14) (#15) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments * removed fluffy comments * Features/2.0/main (#16) * merge main from features/2.0/main (#14) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * pr update 291 (#17) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments * completede basic behavior of 291 and 292 * eslint fix * eslint fix * update from del to put endpoint * basic working version of 291+292 * eslint fix * update import statements + remove pnstram generate * eslint fix * update v2.0 endpoint url to v2.1 * adding basic code * adding basic code * eslint fix * changed from manual retrieving to automatic one within map * eslint fix * Feature/VL-300 (#19) * VL-300 - removed legalFactType path param from api * solved error unmatching types * eslint fix * eslint fix * completed VL-287 * eslint fix * eslint fix * Adding VL-300 on the branch VL-287 (#21) * merge main from features/2.0/main (#14) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * updated yaml to version 2.0 (#23) Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> * merge features/2.0/vl 291 to features/2.0/main (#28) * Adding VL-300 to VL-291 branch (#22) * first basic code handling for notification delete * update package.json * eslint fix * added .use in application.ts * merge main from features/2.0/main (#14) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * merge main from features/2.0/main (#14) (#15) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments * removed fluffy comments --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * eslint fix * eslint fix --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * merge features/2.0/vl 287 to features/2.0/main (#29) * pull from main 2.0 to VL-287 branch (#24) * merge main from features/2.0/main (#14) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments * pr update 291 (#17) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments * completede basic behavior of 291 and 292 * eslint fix * eslint fix * basic working version of 291+292 * eslint fix * changed from manual retrieving to automatic one within map * eslint fix * updated yaml to version 2.0 (#23) Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * fix after pr with 288 * eslint fix --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * merge features/2.0/vl 290 to features/2.0/main (#30) * pull from main 2.0 to VL-287 branch (#24) (#26) * merge main from features/2.0/main (#14) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- * fix tests --------- * removed fluffy comments * pr update 291 (#17) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- * fix tests --------- * removed fluffy comments * completede basic behavior of 291 and 292 * eslint fix * eslint fix * basic working version of 291+292 * eslint fix * changed from manual retrieving to automatic one within map * eslint fix * updated yaml to version 2.0 (#23) --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * Pull from Features/2.0/main to VL-291 #2 (#27) * merge main from features/2.0/main (#14) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments * pr update 291 (#17) * generated yaml from version 2.1 * commented 'F24Metadata' schema inside yaml, due error generating models * updated 'hot-to-generate-the...md' * completed VL-295 * eslint fix * eslint fix * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * changed NewNotificationRequest to NewNotificationRequestV21. Now there are errors before running * fix file with errors after using NewNotificationRequestV21 * fix file with errors after using NewNotificationRequestV21 * eslint fix * completed again VL-295 * completed again VL-295 * completed again VL-295 * still fix to do * added todo denny * first todo denny fix completed * eslint fix * fix for VL-295 due to issue in other files * eslint suggested fixes * eslint suggested fixes * fix for VL-295 w/ Cosmin * eslint fix * eslint fix * eslint fix * changing old type to the new ones * eslint fix * eslint fix * eslint fix * removed unused enum * fix accepted issue * fix tslint issues * fix tslint issue * Features/2.1/main (#12) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * Features/2.1/main (#13) * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * partial permit upload of json during uploadS3 * handled attachmentName 'F24' * completed VL-294 + fix critical severity vulnerability in package-lock.json raised by npm install command * added semicolon due to husky error * eslint fix * fix reference to delivery-push url * fix * fix imports * fix req 7 handling * fix req 7 handling * update package-lock * completed VL-296 * completed VL-296 * VL-298 completed * VL-299 completed * added collection json + 2.1 version * update tests * fix tests * fix tests --------- Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> Co-authored-by: Tuduran, Cosmin Constantin <cosminconstantin.tuduran@nttdata.com> * fix tests --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * removed fluffy comments * completede basic behavior of 291 and 292 * eslint fix * eslint fix * basic working version of 291+292 * eslint fix * changed from manual retrieving to automatic one within map * eslint fix * updated yaml to version 2.0 (#23) Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * fix after VL-288 merge * completed VL-290 * eslint fix * eslint fix * eslint fix --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com> * update index.ts * eslint fix * general fixes for version 2.0 * eslint fix * eslint fix * eslint fix * from main to main/2.0 (#32) (#33) * final fix for main * eslint fix * fix for duplicated timeline event * fix for duplicated timeline event * update postman collection * disabled a test * code duplication fix * fix for code duplication #2 * eslint fix * update to 2.1.1 version * fix for undefined values output obj * eslint fix * completed VL-302 * update package-lock.version --------- Co-authored-by: Cosmin Constantin Tuduran <cosminconstantin.tuduran@nttdata.com> Co-authored-by: Cosmin15 <Tuduran.cosmin@gmail.com>

Improve README

83d9c38

kin0992 marked this pull request as ready for review September 15, 2022 09:02

kin0992 requested a review from datalek as a code owner September 15, 2022 09:02

datalek suggested changes Sep 15, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

cd6a25f

Co-authored-by: AF <4775679+datalek@users.noreply.github.com>

datalek approved these changes Sep 15, 2022

View reviewed changes

gunzip reviewed Sep 15, 2022

View reviewed changes

Fix typos

bc8189b

lordkada force-pushed the improve-documentation branch from c7b407c to bc8189b Compare September 15, 2022 12:45

kin0992 added 2 commits September 15, 2022 15:57

Simplify documentation

6334b46

Remove examples

96884f5

kin0992 added 2 commits September 16, 2022 11:12

Change reference after repository renaming

536d2b1

Change reference after repository renaming in workflows

aa5378f

kin0992 requested a review from datalek September 16, 2022 09:22

datalek approved these changes Sep 16, 2022

View reviewed changes

kin0992 merged commit 817be7b into features/cd-docker-image Sep 16, 2022

kin0992 deleted the improve-documentation branch September 16, 2022 09:25

kin0992 mentioned this pull request Sep 16, 2022

[VL-57] Pipeline to build and push container image #28

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[VL-62] Improve documentation #30

[VL-62] Improve documentation #30

kin0992 commented Sep 15, 2022

kin0992 commented Sep 15, 2022 •

edited

Loading

datalek left a comment

gunzip left a comment

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

gunzip Sep 15, 2022

lordkada commented Sep 15, 2022

kin0992 commented Sep 15, 2022

lordkada commented Sep 16, 2022

kin0992 commented Sep 16, 2022

		```
		Make sure that the path of `.node_version` is correct, because the example commands assumes you are in the repository folder.


		### Run using the public container image

		Another option is to run the container image availeble in the container registry.

[VL-62] Improve documentation #30

[VL-62] Improve documentation #30

Conversation

kin0992 commented Sep 15, 2022

Types of changes

Checklist:

kin0992 commented Sep 15, 2022 • edited Loading

datalek left a comment

Choose a reason for hiding this comment

gunzip left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lordkada commented Sep 15, 2022

kin0992 commented Sep 15, 2022

lordkada commented Sep 16, 2022

kin0992 commented Sep 16, 2022

kin0992 commented Sep 15, 2022 •

edited

Loading