website icon indicating copy to clipboard operation
website copied to clipboard

docs: new streetlights tutorial on how to "generate code"

Open Annysah opened this issue 2 years ago β€’ 4 comments

Description This is the second part of the streetlights tutorial which describes how to "generate code" from the specification document.

Related issue(s) Fixes #1010

Annysah avatar Oct 16 '22 04:10 Annysah

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
Latest commit 43f56b9c117b74d5f1bb444885ee2b5dde02f626
Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/63f936e2aee0820008f1d80e
Deploy Preview https://deploy-preview-1025--asyncapi-website.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Oct 16 '22 04:10 netlify[bot]

Hello @alequetzalli and @derberg , I would love your feedbacks. Thank you!

Annysah avatar Oct 16 '22 04:10 Annysah

⚑️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 58
🟠 Accessibility 88
🟒 Best practices 100
🟒 SEO 100
πŸ”΄ PWA 30

Lighthouse ran on https://deploy-preview-1025--asyncapi-website.netlify.app/

github-actions[bot] avatar Oct 16 '22 04:10 github-actions[bot]

@derberg Thank you for all the suggested changes. I just implemented them. Kindly have a look.

Annysah avatar Oct 22 '22 01:10 Annysah

pingy pongo @derberg 😬😬😬

quetzalliwrites avatar Nov 01 '22 00:11 quetzalliwrites

Hey @Annysah, please review and make sure you resolve all comments in this PR when you address the feedback. It is confusing as it currently stands. πŸ˜„

quetzalliwrites avatar Nov 09 '22 01:11 quetzalliwrites

Hey @Annysah, please review and make sure you resolve all comments in this PR when you address the feedback. It is confusing as it currently stands. πŸ˜„

Noted Alejandra!

Annysah avatar Nov 09 '22 04:11 Annysah

Hi @alequetzalli & @derberg, I just updated the requested changes, kindly help review.

Annysah avatar Nov 13 '22 14:11 Annysah

@alequetzalli & @derberg, all done! Kindly help review. Thank you!

Annysah avatar Nov 25 '22 04:11 Annysah

so I need to add the new CLI installation info block here @Annysah, it's just that I can't do that until my CLI PR https://github.com/asyncapi/website/pull/1139 is merged... stay tuned and I will add it asap πŸ˜„βœŒπŸ½

quetzalliwrites avatar Dec 16 '22 01:12 quetzalliwrites

so I need to add the new CLI installation info block here @Annysah, it's just that I can't do that until my CLI PR #1139 is merged... stay tuned and I will add it asap πŸ˜„βœŒπŸ½

alrighty! ❀️

Annysah avatar Dec 16 '22 02:12 Annysah

Added some comments. Also, I've an advice, if you can add some indentations here. Like the content inside that header should have an indentation of a tab in the left, so that it looks like the content resides in the header section.

sorry, what? πŸ˜„ I don’t understand the indentations feedback at all 😬 @akshatnema

Also, the CLI command here is not rendering properly, as per the backtick used in the code.

oh nooooo ... groans* ... arrghhhh

better open a PR for the fragments file to see how to fix that >_>

quetzalliwrites avatar Jan 25 '23 18:01 quetzalliwrites

opened a bug issue to look into it @akshatnema ✌🏽

https://github.com/asyncapi/website/issues/1308

quetzalliwrites avatar Feb 08 '23 04:02 quetzalliwrites

also there are errors with formatting, look at https://deploy-preview-1025--asyncapi-website.netlify.app/docs/tutorials/generate-code you see, the code snippet is "disconnected" from the number

oh yikes, I missed that! fixing O_O

quetzalliwrites avatar Feb 09 '23 02:02 quetzalliwrites

ooookay so @derberg my findings...

  1. the formatting differences you found are because some code blocks used <CodeBlock language="bash"> (those are the ones that you felt "looked right" and others used ``` (those are the ones that you felt had formatting spacing issues)
  2. I tried to fix it and have them all be <CodeBlock language="bash"> , but now I am getting deployment errors I was unable to figure out on my own and netlify won't generate the latest preview
  3. yay -__- what do I do now?

quetzalliwrites avatar Feb 09 '23 04:02 quetzalliwrites

yo @derberg, so I accepted your commit suggestion fix but it didn't fix the problem :( cry

https://deploy-preview-1025--asyncapi-website.netlify.app/docs/tutorials/generate-code

Screen Shot 2023-02-09 at 11 42 20 AM

quetzalliwrites avatar Feb 09 '23 19:02 quetzalliwrites

/rtm

quetzalliwrites avatar Feb 24 '23 22:02 quetzalliwrites