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: add community docs bucket #1261

Merged

Conversation

magicmatatjahu
Copy link
Member

Description

Add community docs bucket:

  • add new bucket with icon
  • it has higher priority than reference bucket (5 -> 6)
  • use red color - it there a better color for new bucket? Let me know!

@alequetzalli Please fix my description about new bucket 😆

Related issue(s)
Part of #1240

@magicmatatjahu magicmatatjahu added enhancement 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jan 25, 2023
@netlify
Copy link

netlify bot commented Jan 25, 2023

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 5026dc5
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6488b4a39383630008246174
😎 Deploy Preview https://deploy-preview-1261--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.

@github-actions
Copy link

github-actions bot commented Jan 25, 2023

⚡️ Lighthouse report for the changes in this PR:

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

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

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Jan 25, 2023

red feels negative or a reminder to stop something 🛑 🚨 😄😂😂

I would use another color... hmm...

what do you think about orange 🍊 !? @magicmatatjahu

@quetzalliwrites
Copy link
Member

oooh, I was surprised to see that it has higher priority than the reference bucket (5 -> 6)... but I like it! it seems good to not have it be the last content bucket because then it also comes across as being "less important" than the other content buckets 😄

@@ -37,13 +38,20 @@ const cards = [
className: 'bg-primary-200',
Icon: IconGuide,
},
{
title: 'Community',
description: 'Our Community section documents the community guidelines and resources.',
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
description: 'Our Community section documents the community guidelines and resources.',
description: 'Our Community section documents **community** _processes_, **contribution guidelines**, and **resources**.',

Copy link
Member

Choose a reason for hiding this comment

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

how can we add this styling in this js file? 😄😬😬😬😬

Copy link
Member Author

Choose a reason for hiding this comment

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

We can, but what about other buckets and theirs description? Should we also bold some parts?

Copy link
Member

Choose a reason for hiding this comment

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

yeah good point... maybe we shouldn't 🧐

@quetzalliwrites
Copy link
Member

Screen Shot 2023-01-25 at 10 19 31 AM

oooh what do you think? hehe 🙃

@magicmatatjahu
Copy link
Member Author

@alequetzalli Ok, I changed color to the orange, WDYT?

@magicmatatjahu
Copy link
Member Author

@derberg I need approve :)

@derberg
Copy link
Member

derberg commented Jan 31, 2023

I don't recall we had a final decision if community docs should be mixed with user documentation -> asyncapi/community#525

@magicmatatjahu
Copy link
Member Author

@derberg Then discuss that with @alequetzalli 😄

@derberg
Copy link
Member

derberg commented Feb 23, 2023

@alequetzalli we need to go further here, remember -> https://github.com/orgs/asyncapi/discussions/525#discussioncomment-4224105 😄

@derberg
Copy link
Member

derberg commented Mar 20, 2023

ok then, I guess we can go with this one, except the fact that Community bucket should not be mixed in between spec tech docs we need:

concepts
tutorials
tools
guides
reference
community # last on the list

or

concepts
tutorials
guides
reference
community
tools

@quetzalliwrites
Copy link
Member

I prefer the first option, but I'm I'm also struggling with the idea of the community content bucket being the last one 🤔

I'm not sure if I'm overthinking it but would having the community content bucket last make it seem like it's the least important topic?

Copy link
Member

derberg commented Mar 20, 2023

make it seem like it's the least important topic

It might, but logically it makes sense imho. 2nd option logically also makes sense as tools are also something extra. So maybe 2nd is better

@quetzalliwrites
Copy link
Member

Yeah totally...

I still vote for option 1 tho because it's more likely a better user experience to have tools higher up if tools docs receive more visits than community docs.

It would probably be a good idea to look at the stats currently in analytics, and if tools docs are getting the majority of visits, then we shouldn't put it at the bottom where users will need to scroll all the way to find it in the left-hand navigation.

Copy link
Member

derberg commented Mar 21, 2023

Below shows stats for this year (Generator docs were merged at the end of December).

Screenshot 2023-03-21 at 12.25.04.png

I'm ok with any solution as long as Reference is not at the end. And yeah, Guides are pretty hidden after Tools (although there were released a month ago or so? thus numbers are not that great maybe)

quetzalliwrites
quetzalliwrites previously approved these changes Jun 7, 2023
moving community content bucket to last place
@quetzalliwrites
Copy link
Member

quetzalliwrites commented Jun 7, 2023

Screen Shot 2023-06-06 at 7 15 29 PM

Can we move this PR forward @akshatnema? 🤔 😄 I am hoping we don't wait for Lukasz to finish vacation because this has been lagging for too long already.

Since I fixed it so that Reference is no longer the last content bucket (the last concern lukasz had), I think this looks good to go. Do you agree and/or are you able to merge?

@quetzalliwrites quetzalliwrites self-assigned this Jun 7, 2023
@quetzalliwrites quetzalliwrites linked an issue Jun 7, 2023 that may be closed by this pull request
18 tasks
@quetzalliwrites
Copy link
Member

yo @akshatnema, pingy pongo 😄

@akshatnema
Copy link
Member

/rtm

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 enhancement ready-to-merge
Projects
Status: Community PR under Review 🧐
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: create AsyncAPI Docs Style Guide
5 participants