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

feat: reorganize community page #552

Merged
merged 10 commits into from
Dec 18, 2023
Merged

Conversation

SebastianBezold
Copy link
Contributor

Description

This PR is a complete reorg of our community page. It is changing it from being a Docusaurus page to docs.

This comes with the advantage, that we can have a sidebar and structure the community section into multiple pages, making it easier to find content.

The PR introduces the following structure

Community:

  • Intro -> Communication rules and contact channels
  • Open Meetings -> List of all open meetings with info to schedule and how to join (new component)
  • Meeting Minutes -> A link to a blog similar to News
  • Products -> This is the product overview, that we already know, but as a separate page

Considerations / Discussion

As mentioned in the corresponding discussion, it could be useful to add downloadable .ics files for the open meetings. This is not yet included, but could be added.

Using the Docusaurus blog plugin for meeting minutes has a lot of advantages, like feed options, authors, sorting by date and so on. But is also comes with a drawback, that the blog does have its own sidebar. This somewhat breaks the navigation of the community section. A possible mitigation could be, to list it as last menu item in my opinion.

Related issue

fixes #523

Screenshots

Community section:
image

Open Meetings overview:
image

Meeting Minute Blog:
image

@FaGru3n
Copy link
Contributor

FaGru3n commented Dec 12, 2023

Hi @SebastianBezold really great work!

one thing i regognized after rebuild form your branch on my local side... it seems that "Meeting Minute Blog" does not have the navigation sidebar on the left... or was that your plan?

image

@SebastianBezold
Copy link
Contributor Author

Hi @SebastianBezold really great work!

one thing i regognized after rebuild form your branch on my local side... it seems that "Meeting Minute Blog" does not have the navigation sidebar on the left... or was that your plan?

image

Hi @FaGru3n,

yes, that is what I meant in the PR description under "consideration". Unfortunately, this is how the blog plugin works. So far, I haven't found a solution, where we can use the plugin, but keep the docs sidebar.
We could think about re-ordering the menu items, that it's at least shown in the end, or maybe move the meeting minutes to a completely separate top-level menu item

@FaGru3n
Copy link
Contributor

FaGru3n commented Dec 12, 2023

We could think about re-ordering the menu items, that it's at least shown in the end, or maybe move the meeting minutes to a completely separate top-level menu item

i like the idea for completely separate top-level menu item "Open Meeting Blog" or "Open Office Meeting Minutes" something like that... 👍🏼

@stephanbcbauer
Copy link
Member

i like the idea/poc ... will build it locally tomorrow and would like to give feedback afterwards. Thanks for your effort

@stephanbcbauer
Copy link
Member

Thumbs up @SebastianBezold just built it locally and the new structure looks really great. I also like the tags in the meeting minutes. For the open meetings it would be cool to provide an ics file, or the meeting link.

Again. The new structure rocks.

@SebastianBezold
Copy link
Contributor Author

Thumbs up @SebastianBezold just built it locally and the new structure looks really great. I also like the tags in the meeting minutes. For the open meetings it would be cool to provide an ics file, or the meeting link.

Again. The new structure rocks.

Cool thanks for having a look. I just pushed some last changes, that I wanted to do for this PR:

  • Moving the meeting minutes to be the last navigation item -> I think this mitigates the disappearing navigation
  • Moving community content to it's own directory -> not hidden in docs and URL is now /community instead of /docs/community
  • Creating a dedicated sidebar config for /community
  • Adding a client-side redirect from /community to /community/intro -> if you view the meeting minutes and just delete the last part of the URL, you'll be redirected to an existing page

What do you think: If enough people agree, I would merge this PR and work on integrating the Release Information and Changelog from "Versions" to the community section in a new PR

@stephanbcbauer
Copy link
Member

Thumbs up @SebastianBezold just built it locally and the new structure looks really great. I also like the tags in the meeting minutes. For the open meetings it would be cool to provide an ics file, or the meeting link.
Again. The new structure rocks.

Cool thanks for having a look. I just pushed some last changes, that I wanted to do for this PR:

  • Moving the meeting minutes to be the last navigation item -> I think this mitigates the disappearing navigation
  • Moving community content to it's own directory -> not hidden in docs and URL is now /community instead of /docs/community
  • Creating a dedicated sidebar config for /community
  • Adding a client-side redirect from /community to /community/intro -> if you view the meeting minutes and just delete the last part of the URL, you'll be redirected to an existing page

What do you think: If enough people agree, I would merge this PR and work on integrating the Release Information and Changelog from "Versions" to the community section in a new PR

Last question. For the open meetings section, it looks right now more like documenting “regular” meetings. Could I also use this page to promote my (every 3 month meetings)? Refinement, Guardrails...

So what i mean for one year i would have something like 4 Guardrails, 4 Refinements... with the ics file to download and a meeting link :)

Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

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

LGTM ...

... Last question. For the open meetings section, it looks right now more like documenting “regular” meetings. Could I also use this page to promote my (every 3 month meetings)? Refinement, Guardrails...

So what I mean for one year I would have about 4 Guardrails, 4 Refinements... with the ICS file to download and a meeting link :)

@SebastianBezold
Copy link
Contributor Author

LGTM ...

... Last question. For the open meetings section, it looks right now more like documenting “regular” meetings. Could I also use this page to promote my (every 3 month meetings)? Refinement, Guardrails...

So what I mean for one year I would have about 4 Guardrails, 4 Refinements... with the ICS file to download and a meeting link :)

I could think of two possible solutions:

  • easy: Just add the appointments with the MeetingInfo component when you need them to be visible and remove them, when you think they are no longer needed. Potentially a lot of updates to the page, but nothing critical
  • Enhance the component or create a wrapper, that takes a complete list of meetings and interprets the date, to only render the ones that are either regular, or in a specified time range (i.e. 3 months before it takes place and two weeks after it was held)

Can definitely work on that the next year 😁

Copy link
Contributor

@carslen carslen left a comment

Choose a reason for hiding this comment

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

LGTM. Reasonable changes

Copy link
Contributor

@FaGru3n FaGru3n left a comment

Choose a reason for hiding this comment

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

LGTM

@SebastianBezold SebastianBezold merged commit 0ea6753 into main Dec 18, 2023
4 checks passed
@SebastianBezold SebastianBezold deleted the reorganize-community-section branch December 18, 2023 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Re-organize "Community" section
4 participants