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

Create a new page for Community inside the Overview Section of the Docs. #280

Closed
Tracked by #158
benjagm opened this issue Jan 25, 2024 · 30 comments
Closed
Tracked by #158
Assignees
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Priority: High After critical issues are fixed, these should be dealt with before any further issues. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Jan 25, 2024

Description

Create a new page for Community inside the Overview Section of the Docs.

  • Explaining all community channels.
  • All community meetings.
  • Blog.
  • All community programs.
  • Members of the tsc, contributors and ambassadors.

Do you think this work might require an Architectural Decision Record (ADR)? (significant or noteworthy)

No

@benjagm benjagm added the ✨ Enhancement Indicates that the issue suggests an improvement or new feature. label Jan 25, 2024
@Gmin2
Copy link
Contributor

Gmin2 commented Feb 5, 2024

@benjagm working on it

@benjagm benjagm self-assigned this Feb 5, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Feb 5, 2024

Thanks @Min2who ! We didn't have a design yet but in my mind this is the a great example of Community page: https://www.asyncapi.com/community

Happy to provide a low-level prototype of the page.

@Gmin2
Copy link
Contributor

Gmin2 commented Feb 8, 2024

Thanks @Min2who ! We didn't have a design yet but in my mind this is the a great example of Community page: https://www.asyncapi.com/community

Happy to provide a low-level prototype of the page.

@benjagm i should work on this or not as you have assigned it to yourself

@benjagm benjagm added the Status: Available No one has claimed responsibility for resolving this issue. label Feb 20, 2024
@praveen-rikhari
Copy link
Contributor

Hii @benjagm do you have the low level prototype ready, if yes can you please share it here, i would like to work on this and atleast have a foundation set up for the page

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 27, 2024

This is the prototype of the new page I'd love to have. Sections:

  1. Hero
  2. Section with 2 columns
    2.1 Card for Roadmap
    2.2 Card for contributing guidelines
  3. Card Section for slack
  4. Card for ambassadors program
  5. Card for events (reuse code from the landing page) (content of future events is dynamic. see landing)
  6. Card for blog (In the right side well show the last blog published like we do in the landing page)

Image
Image

For this prototype I used screenshot from others sites so you will need to adapt colours and styles to JSON Schema.

Please leave fake text for all sections and as soon we are fine with the design I'll complete the PR with the real texts/links.

@benjagm benjagm removed their assignment Feb 27, 2024
@pi600
Copy link

pi600 commented Feb 27, 2024

can i get assigned and work on it @benjagm

@varunsh17
Copy link

I have intrest in this kind of work, may I get it assigned to start work immediately?

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 27, 2024

Thanks for your interest @pi600 All yours. The prototype is just low fidelity. You'll need to adjust all the styles to JSON Schema and be creative. Reach out to me in Slack anytime if you have doubts.

For the text, please use fake text for all sections and as soon we are fine with the design I'll complete the PR with the real texts/links.

This new page will go under the overview section in the sidebar of the docs.

Thanks!

@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Feb 27, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Mar 1, 2024

@pi600 let us know if you need support. @varunsh17 offered help with this one. @utnim2 Could you please join me as reviewer of the PR?

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 3, 2024

Hi @pi600 we'll need to increate the priority of this issue because there are others depending on it. I will make this available for others to work on this. Thanks.

@benjagm benjagm added Priority: High After critical issues are fixed, these should be dealt with before any further issues. Status: Available No one has claimed responsibility for resolving this issue. and removed Status: In Progress This issue is being worked on, and has someone assigned. labels Mar 3, 2024
@officeneerajsaini
Copy link
Contributor

I want to work on this issue

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 3, 2024

Thanks helping with this one. All yours.

@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Mar 3, 2024
@officeneerajsaini
Copy link
Contributor

Thanks for assign to me 🫠@benjagm

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 3, 2024

Hey @officeneerajsaini When creating the border/shadow effects for each big card/section please use the same format we are using in the landing page for this section:

Screenshot 2024-03-03 at 23 40 43

@officeneerajsaini
Copy link
Contributor

@benjagm maybe this issue related to Json Scheme Docs ? Because i need to done 1 Doc Contribution for Qualification Task .

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 4, 2024

@benjagm maybe this issue related to Json Scheme Docs ? Because i need to done 1 Doc Contribution for Qualification Task .

I am sorry but I dont fully understand this comment. Can you please clarify?

@officeneerajsaini
Copy link
Contributor

@benjagm Sorry for any confusion, I'm just asking if this issue is related to documentation.

@Gmin2
Copy link
Contributor

Gmin2 commented Mar 5, 2024

  1. Hero
  2. Section with 2 columns
    2.1 Card for Roadmap
    2.2 Card for contributing guidelines
  3. Card Section for slack
  4. Card for ambassadors program
  5. Card for events (reuse code from the landing page) (content of future events is dynamic. see landing)
  6. Card for blog (In the right side well show the last blog published like we do in the landing page)

Hey @officeneerajsaini you need to implement the above components for creating a new community page

@officeneerajsaini
Copy link
Contributor

@utnim2 yes

@Gmin2
Copy link
Contributor

Gmin2 commented Mar 6, 2024

Hey @officeneerajsaini have you faced this error while running yarn build ?

@officeneerajsaini
Copy link
Contributor

@utnim2, when I try to commit on my local machine, those errors are showing. But now I've fixed all of them.

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 6, 2024

With the issue #322 we added specific checks for linting error, format fix and typechecks. This is important when we have this high number of contributors.

You will need to fix it manually or use prettier to fix it for you with a command like this:

npx prettier --write path-of-the-file-to-format

@officeneerajsaini
Copy link
Contributor

Thank You @benjagm

@benjagm benjagm added this to the Docs Release 3 milestone Mar 6, 2024
@officeneerajsaini
Copy link
Contributor

@officeneerajsaini
Copy link
Contributor

Description

Create a new page for Community inside the Overview Section of the Docs.

  • Explaining all community channels.
  • All community meetings.
  • Blog.
  • All community programs.
  • Members of the tsc, contributors and ambassadors.

Do you think this work might require an Architectural Decision Record (ADR)? (significant or noteworthy)

No

I think we can add this to the community section in the navbar. That should be a good place for it. What do you say about this, Benjagm?

@officeneerajsaini
Copy link
Contributor

Description

Create a new page for Community inside the Overview Section of the Docs.

  • Explaining all community channels.
  • All community meetings.
  • Blog.
  • All community programs.
  • Members of the tsc, contributors and ambassadors.

Do you think this work might require an Architectural Decision Record (ADR)? (significant or noteworthy)
No

I think we can add this to the community section in the navbar. That should be a good place for it. What do you say about this, Benjagm?

@benjagm

@radhesh1
Copy link

is this open?

@officeneerajsaini
Copy link
Contributor

yes , i am still working on it .

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 15, 2024

This is now merged into the dev branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Priority: High After critical issues are fixed, these should be dealt with before any further issues. Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

No branches or pull requests

7 participants