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.

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

[📑 Docs]: Adapt hello world tutorial for v3 #1857

Closed
jonaslagoni opened this issue Jun 28, 2023 · 11 comments
Closed

[📑 Docs]: Adapt hello world tutorial for v3 #1857

jonaslagoni opened this issue Jun 28, 2023 · 11 comments
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers

Comments

@jonaslagoni
Copy link
Member

jonaslagoni commented Jun 28, 2023

For AsyncAPI v3, we need to adapt the hello world tutorial (https://www.asyncapi.com/docs/tutorials/getting-started/hello-world) to be usable with AsyncAPI v3.

Here are the v3 structure that should be used instead:

asyncapi: 3.0.0
info:
  title: Hello world application
  version: '0.1.0'

channels:
  hello:
    address: 'hello'
    messages:
      sayHelloMessage:
        payload:
          type: string
          pattern: '^hello .+$'

operations:
  receiveHello:
    action: 'receive'
    channel:
      $ref: '#/channels/hello'

Here are the main points that need to change:

  • Re-add the docs/tutorials/getting-started/hello-world.md file.
  • Adapt the AsyncAPI document snippets
  • Adapt the text to explain the v3 structure

Make sure you base your change on the next-major-spec branch and target it in your PR 🙂 If you have any questions, don't hesitate to ask.

@quetzalliwrites quetzalliwrites added good first issue Good for newcomers 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jun 29, 2023
@dssitachi
Copy link

I would like to work on this issue. Could you assign it to me?

@alaminthetrustworthy
Copy link
Contributor

@jonaslagoni i would like to work on this task

@jonaslagoni
Copy link
Member Author

No assignment, just say you work on it, since nothing has happened in 3 weeks I assume you moved on @dssitachi, go ahead @alaminthespecial 🙂

@alaminthetrustworthy
Copy link
Contributor

ok @jonaslagoni

@alaminthetrustworthy
Copy link
Contributor

Hi, @jonaslagoni ,@alequetzalli am little bit confuse, I have folk the asyncApi/website and completed some of the task when i read the contribution guidance it says we should avoid using master branch while proposing for changes and I can only find docs/tutorials/getting-started/hello-world.md file when am in Master branch. And the issue can only be updated on when my base branch is next-major-spec please i need some clarification i want to propose change.
Additional in the previous doc there is no operations section am also confused for that some explaination. thank you

@AnimeshKumar923
Copy link
Contributor

I have folk the asyncApi/website and completed some of the task when i read the contribution guidance it says we should avoid using master branch while proposing for changes and I can only find docs/tutorials/getting-started/hello-world.md file when am in Master branch. And the issue can only be updated on when my base branch is next-major-spec please i need some clarification i want to propose change.
Additional in the previous doc there is no operations section am also confused for that some explaination. thank you

@alaminthespecial Hey there 👋 We can have a google meet call and discuss this issue. DM me on Slack if you're comfortable with it.

@alaminthetrustworthy
Copy link
Contributor

sure i have DM you

@alaminthetrustworthy
Copy link
Contributor

alaminthetrustworthy commented Jul 25, 2023

hello @jonaslagoni I need some clarification on operation section of asyncApi v3 which was not there in previous examples

@jonaslagoni
Copy link
Member Author

I would leave it blank and create the PR and join a spec 3.0 docs meeting to get help how to best phrase it, or look at some other documentations how they describe operations in AsyncAPI and make a first draft 🙂

@alaminthetrustworthy
Copy link
Contributor

alaminthetrustworthy commented Jul 29, 2023

hi @jonaslagoni @alequetzalli i have make a PR can you help me review it #2004

@derberg
Copy link
Member

derberg commented Nov 13, 2023

solved with #2004
in next major branch, but considered to be fixed and closing - also for easier management of the scope for v3

@derberg derberg closed this as completed Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers
Projects
Status: Changes proposed 📄
Development

No branches or pull requests

6 participants