docs: split hello world tutorial into two (send and receive) #2981
Conversation
quetzalliwrites
added
📑 docs
area/docs
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
asyncapi-bot
requested review from
sambhavgupta0705,
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
quetzalliwrites
requested review from
derberg,
J0SAL,
VaishnaviNandakumar and
TRohit20
and removed request for
VaishnaviNandakumar,
J0SAL,
BhaswatiRoy,
sambhavgupta0705 and
TRohit20
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-2981--asyncapi-website.netlify.app/ |
pages/docs/tutorials/getting-started/hello-world-send-message.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Kindly change the folder for these files, as inside markdown.
There was a problem hiding this comment.
Got it, thanks for the reminder!
|
what happens with https://github.com/asyncapi/website/blob/master/markdown/docs/tutorials/getting-started/hello-world.md tutorial? shouldn't one of new once replace it with same filename but different title (asking because of dead links) |
|
|
||
| The `operations` section is where you describe what the application is doing. Each operation has a unique identifier for example, `sendHello`. | ||
|
|
||
| In the above example, you see that the `Hello world application` is a producer sending the `sayHelloMessage` message from the `hello` channel. In other words, you can say that the `Hello world application` publishes the `hello` topic to `send` the `sayHelloMessage` message. That AsyncAPI document describes what the `Hello world application` is doing, not what others can do with it. |
There was a problem hiding this comment.
| In the above example, you see that the `Hello world application` is a producer sending the `sayHelloMessage` message from the `hello` channel. In other words, you can say that the `Hello world application` publishes the `hello` topic to `send` the `sayHelloMessage` message. That AsyncAPI document describes what the `Hello world application` is doing, not what others can do with it. | |
| In the above example, you see that the `Hello world application` is a producer sending the `sayHelloMessage` message to the `hello` channel. In other words, you can say that the `Hello world application` `send` the `sayHelloMessage` message to the `hello` topic. That AsyncAPI document describes what the `Hello world application` is doing, not what others can do with it. |
| @@ -0,0 +1,120 @@ | |||
| --- | |||
| title: "Receive 'Hello world' message" | |||
There was a problem hiding this comment.
the only difference in this document is receive operation and there is a lot of repetition - is it intended? especially that app name is the same Hello world application. Shouldn't it be done like other tuturials for example for Kafka, where first tutorial would be about send message, and the one about receiving would be "extending" the send-one, where you extend the document with additional receive operation (of course still explaining these can be separate)
|
There would no longer be that link. Instead, we would have two new links that help differentiate the two hello world tutorials in this section. As for dead links, I will make sure to check for any in this PR too now that it's being reviewed. |
|
then we need redirect from old link to a new one, for external resources that link to the current document, to not cause dead links |
|
Oh, right! I forgot, thanks for reminding me. smh 🤦♀️ Can you remind/tell me where I should be adding the redirect links? I remember before I did it for the spec docs, but this is the website repo and I'm unsure. 🫤 |
|
/update |
Resolves #993 and comment by @derberg via #993 (comment).