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: new tutorial "generate code" #1025

Merged
merged 43 commits into from Feb 24, 2023

Conversation

Annysah
Copy link
Contributor

@Annysah Annysah commented Oct 16, 2022

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

@netlify
Copy link

netlify bot commented Oct 16, 2022

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 43f56b9
🔍 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.

@Annysah
Copy link
Contributor Author

Annysah commented Oct 16, 2022

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

@github-actions
Copy link

github-actions bot commented Oct 16, 2022

⚡️ 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/

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Annysah yo, left some feedback.

@alequetzalli just thinking, if in case of this split of streetlight tutorial, maybe we should have a separate branch, as I think it only makes sense to release all of them at once

pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generating-code.md Outdated Show resolved Hide resolved
@Annysah
Copy link
Contributor Author

Annysah commented Oct 22, 2022

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

@alequetzalli alequetzalli added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Oct 24, 2022
@alequetzalli alequetzalli added this to Community PR under Review 🧐 in AsyncAPI Docs Board Oct 24, 2022
@alequetzalli alequetzalli changed the title docs: new streetlights tutorial on how to "generate code" docs: new tutorial "generate code" Oct 26, 2022
@alequetzalli
Copy link
Member

pingy pongo @derberg 😬😬😬

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for delayed review, conference occupied me a lot last days before it.

left some comments

pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
@alequetzalli
Copy link
Member

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. 😄

@alequetzalli
Copy link
Member

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

@alequetzalli
Copy link
Member

alequetzalli commented Feb 9, 2023

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?

@alequetzalli
Copy link
Member

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

pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
pages/docs/tutorials/generate-code.md Outdated Show resolved Hide resolved
alequetzalli and others added 3 commits February 21, 2023 18:57
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
@alequetzalli
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 1154883 into asyncapi:master Feb 24, 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 gsod This label should be used for issues or discussions related to ideas for Google Season of Docs ready-to-merge
Projects
Status: Done 🚀
AsyncAPI Docs Board
  
Community PR under Review 🧐
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: new tutorial: "how to generate code with asyncapi"
6 participants