docs: add better examples and documentation #391

jonaslagoni · 2021-11-30T15:46:39Z

Description

This PR adds better examples and documentation, similar to what is introduced to Modelina.

What is added:

new example setup, which includes usages and tests.
Adapted readme's to reflect new examples setup.
New workflow file to test that examples work

# Conflicts: # examples/publish subscribe/streetlight/lib/NatsTypescriptTemplateError.js # examples/publish subscribe/streetlight/lib/NatsTypescriptTemplateError.js.map # examples/publish subscribe/streetlight/lib/channels/StreetlightStreetlightIdCommandTurnon.d.ts # examples/publish subscribe/streetlight/lib/channels/StreetlightStreetlightIdCommandTurnon.js # examples/publish subscribe/streetlight/lib/channels/StreetlightStreetlightIdCommandTurnon.js.map # examples/publish subscribe/streetlight/lib/channels/StreetlightStreetlightIdEventTurnon.d.ts # examples/publish subscribe/streetlight/lib/channels/StreetlightStreetlightIdEventTurnon.js # examples/publish subscribe/streetlight/lib/channels/StreetlightStreetlightIdEventTurnon.js.map # examples/publish subscribe/streetlight/lib/index.d.ts # examples/publish subscribe/streetlight/lib/index.js # examples/publish subscribe/streetlight/lib/index.js.map # examples/publish subscribe/streetlight/lib/models/AnonymousSchema_1.d.ts # examples/publish subscribe/streetlight/lib/models/AnonymousSchema_1.js # examples/publish subscribe/streetlight/lib/models/AnonymousSchema_1.js.map # examples/publish subscribe/streetlight/lib/models/AnonymousSchema_3.d.ts # examples/publish subscribe/streetlight/lib/models/AnonymousSchema_3.js # examples/publish subscribe/streetlight/lib/models/AnonymousSchema_3.js.map # examples/publish subscribe/streetlight/lib/testclient/index.d.ts # examples/publish subscribe/streetlight/lib/testclient/index.js # examples/publish subscribe/streetlight/lib/testclient/index.js.map # examples/publish subscribe/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.d.ts # examples/publish subscribe/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.js # examples/publish subscribe/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.js.map # examples/publish subscribe/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdEventTurnon.d.ts # examples/publish subscribe/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdEventTurnon.js # examples/publish subscribe/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdEventTurnon.js.map # examples/publish subscribe/streetlight/package-lock.json # examples/publish subscribe/streetlight/src/channels/StreetlightStreetlightIdCommandTurnon.ts # examples/publish subscribe/streetlight/src/channels/StreetlightStreetlightIdEventTurnon.ts # examples/publish subscribe/streetlight/src/index.ts # examples/publish subscribe/streetlight/src/testclient/index.ts # examples/publish subscribe/streetlight/src/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.ts # examples/publish subscribe/streetlight/src/testclient/testchannels/StreetlightStreetlightIdEventTurnon.ts # examples/publish subscribe/streetlight/tests/integration/StreetlightStreetlightIdCommandTurnon.spec.ts # examples/publish subscribe/streetlight/tests/integration/StreetlightStreetlightIdEventTurnon.spec.ts # examples/request reply/streetlight/lib/NatsTypescriptTemplateError.js # examples/request reply/streetlight/lib/NatsTypescriptTemplateError.js.map # examples/request reply/streetlight/lib/channels/StreetlightStreetlightIdCommandTurnon.d.ts # examples/request reply/streetlight/lib/channels/StreetlightStreetlightIdCommandTurnon.js # examples/request reply/streetlight/lib/channels/StreetlightStreetlightIdCommandTurnon.js.map # examples/request reply/streetlight/lib/channels/StreetlightStreetlightIdEventTurnon.d.ts # examples/request reply/streetlight/lib/channels/StreetlightStreetlightIdEventTurnon.js # examples/request reply/streetlight/lib/channels/StreetlightStreetlightIdEventTurnon.js.map # examples/request reply/streetlight/lib/index.d.ts # examples/request reply/streetlight/lib/index.js # examples/request reply/streetlight/lib/index.js.map # examples/request reply/streetlight/lib/models/AnonymousSchema_1.d.ts # examples/request reply/streetlight/lib/models/AnonymousSchema_1.js # examples/request reply/streetlight/lib/models/AnonymousSchema_1.js.map # examples/request reply/streetlight/lib/models/AnonymousSchema_5.d.ts # examples/request reply/streetlight/lib/models/AnonymousSchema_5.js # examples/request reply/streetlight/lib/models/AnonymousSchema_5.js.map # examples/request reply/streetlight/lib/models/GeneralReply.d.ts # examples/request reply/streetlight/lib/models/GeneralReply.js # examples/request reply/streetlight/lib/models/GeneralReply.js.map # examples/request reply/streetlight/lib/testclient/index.d.ts # examples/request reply/streetlight/lib/testclient/index.js # examples/request reply/streetlight/lib/testclient/index.js.map # examples/request reply/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.d.ts # examples/request reply/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.js # examples/request reply/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.js.map # examples/request reply/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdEventTurnon.d.ts # examples/request reply/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdEventTurnon.js # examples/request reply/streetlight/lib/testclient/testchannels/StreetlightStreetlightIdEventTurnon.js.map # examples/request reply/streetlight/package-lock.json # examples/request reply/streetlight/src/channels/StreetlightStreetlightIdCommandTurnon.ts # examples/request reply/streetlight/src/channels/StreetlightStreetlightIdEventTurnon.ts # examples/request reply/streetlight/src/index.ts # examples/request reply/streetlight/src/testclient/index.ts # examples/request reply/streetlight/src/testclient/testchannels/StreetlightStreetlightIdCommandTurnon.ts # examples/request reply/streetlight/src/testclient/testchannels/StreetlightStreetlightIdEventTurnon.ts # examples/simple-reply/asyncapi-nats-client/API.md # examples/simple-request/asyncapi-nats-client/API.md # package-lock.json

# Conflicts: # examples/publish subscribe/streetlight/package-lock.json # examples/request reply/streetlight/package-lock.json # package-lock.json

jonaslagoni · 2021-12-14T13:47:20Z

@alequetzalli do you mind reviewing the doc and example changes? 😄

examples/simple-reply/README.md

examples/simple-request/README.md

examples/simple-request/asyncapi-nats-client/API.md

quetzalliwrites

Ok, finished my review, @jonaslagoni :)

Co-authored-by: Alejandra Quetzalli <[email protected]>

jonaslagoni · 2021-12-16T12:06:08Z

Ok, finished my review, @jonaslagoni :)

Thanks, @alequetzalli 🎉

Guess I didn't manage to fix the windows problem in time 🤣

quetzalliwrites

LGTM 🚀

jonaslagoni · 2021-12-21T15:39:44Z

@all-contributors please add @alequetzalli for review

allcontributors · 2021-12-21T15:39:52Z

@jonaslagoni

I've put up a pull request to add @alequetzalli! 🎉

asyncapi-bot · 2022-01-03T14:04:30Z

🎉 This PR is included in version 0.5.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

jonaslagoni added 5 commits November 29, 2021 15:09

WIP

3e2c689

Merge branch 'master-main-rep' into feature/examples_and_documentations

246b91f

Added request example

d50cf90

Fixed script setup

3e1b1b5

Added example testing workflow

f41a7de

jonaslagoni changed the title ~~docs: adding better examples and documentation~~ docs: add better examples and documentation Nov 30, 2021

jonaslagoni added 7 commits November 30, 2021 16:47

Changed script names

21c34ad

Add reply

4e3228a

Removed lib folder for examples

d7e23c4

updated examples

55e0c9a

Changed reply example

5abf707

Update reply example

08d8d82

Updated examples

689ee0d

jonaslagoni mentioned this pull request Dec 14, 2021

Generate tests for different payloads #9

Closed

jonaslagoni added 5 commits December 14, 2021 10:30

Simplified script setup and fixed tests

10ad240

Adapted readmes

a2f5a30

Merge branch 'master-main-rep' into feature/examples_and_documentations

e301af7

# Conflicts: # examples/publish subscribe/streetlight/package-lock.json # examples/request reply/streetlight/package-lock.json # package-lock.json

Fixed indentation

4cf30a1

jonaslagoni marked this pull request as ready for review December 14, 2021 13:46

jonaslagoni requested a review from quetzalliwrites December 14, 2021 13:46

jonaslagoni added 8 commits December 14, 2021 14:53

Fixed missing run keyword for workflow

72d846e

Removed unused workflow

37afd50

Fixed windows could not execute example script

458ab24

Fixed path was not being resolved for windows environment

74d5db1

Fixed path was not being resolved for windows environment

b879c5a

Fixed path was not being resolved for windows environment

02f036e

Fixed path was not being resolved for windows environment

6c5378a

Fixed path was not being resolved for windows environment

89aa624