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 style guide - Grammar #1343

Closed
wants to merge 29 commits into from

Conversation

Arya-Gupta
Copy link
Contributor

@Arya-Gupta Arya-Gupta commented Feb 14, 2023

Fix: #1250

Added style guide for grammar:

  • Abbreviations and Acronyms
  • Active voice
  • Capitalization
  • Spelling
  • Verb tense

@netlify
Copy link

netlify bot commented Feb 14, 2023

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit cb41122
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/649efc34e9ed010008e5656e
😎 Deploy Preview https://deploy-preview-1343--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 configuration.

@thulieblack
Copy link
Member

Hey @Arya-Gupta please add meta-data,
image
index, and section page to your docs
image

@Arya-Gupta Arya-Gupta requested a review from thulieblack April 11, 2023 15:04
Co-authored-by: V Thulisile Sibanda <[email protected]>
@Arya-Gupta Arya-Gupta requested a review from thulieblack April 12, 2023 15:09
title: Grammar
description: This page explains how to use Grammar when writing docs
---
#Grammar
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#Grammar
## Grammar

Please add introduction content to the first header, introducing the reader to this Grammar Style Guide document.

Copy link
Member

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

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

Hey there @Arya-Gupta! Thank you so much for your incredible patience in waiting for me to review your work... interviewing and onboarding the 2023 gsod folks took more of my energy than I anticipated, and I had to put Style Guide tasks in the back burner for a little bit 😬.

I hope you are still interested in contributing to this issue, I really do look forward to continuing working with you on this one 😄✌🏽. Thank you again for your hard work so far!

Copy link
Member

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

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

This looks SOOOO CLOSE to being done @Arya-Gupta! Once again, great job. 🔥

There is just one pending item to fix.

Copy link
Member

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

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

this looks amazing, great job!! :)

@quetzalliwrites
Copy link
Member

Heyo, your directory structure is wrong because it's missing a dash to separate the words style-guide. 😄 Your directory needs to be:
asyncapi.com/docs/community/style-guide/grammar.

@quetzalliwrites
Copy link
Member

P.S. I didn't mention this before because we JUST merged our new Community content bucket into the docs this week... but now that we have a LIVE Community content bucket in the docs, we actually should be authoring community docs directly in the /Community repo. (We actually have similar behavior/process in place for tools and specification docs too! Tools and specification docs are actually stored in their repoes and then copies to our website repo docs.)

I would work on your second draft and create a NEW PR in the community repo when you have it ready to review.

Please let me know if this doesn't make sense!

@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jun 16, 2023
@github-actions
Copy link

github-actions bot commented Jun 16, 2023

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 59
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🔴 PWA 30

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

@Arya-Gupta
Copy link
Contributor Author

Thank you! I've fixed the directory issue. There were some merge conflicts which I resolved, I hope I did it correctly.

@Arya-Gupta
Copy link
Contributor Author

P.S. I didn't mention this before because we JUST merged our new Community content bucket into the docs this week... but now that we have a LIVE Community content bucket in the docs, we actually should be authoring community docs directly in the /Community repo. (We actually have similar behavior/process in place for tools and specification docs too! Tools and specification docs are actually stored in their repoes and then copies to our website repo docs.)

I would work on your second draft and create a NEW PR in the community repo when you have it ready to review.

Please let me know if this doesn't make sense!

I'm a bit confused. You want me to make the same PR here?

@quetzalliwrites
Copy link
Member

I'm a bit confused. You want me to make the same PR here?

Yes, that is exactly right 😄. No worries, I can understand the confusion. Since we have a call tmw, we can go over this in more detail and I can explain to you again why we are making this change. ✌🏽

@Arya-Gupta
Copy link
Contributor Author

Closing this pull request as this is being moved over to Community.

@Arya-Gupta Arya-Gupta closed this Jul 1, 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
Projects
Status: Community PR under Review 🧐
Development

Successfully merging this pull request may close these issues.

docs: new style guide - Grammar
3 participants