Skip to content

📝 events: 2023-2024 refresh of event request guidelines

JWF requested to merge fix/mindshare-event-request-templates into main

This commit is a refresh of the Fedora Mindshare Committee event request guidelines. There are not major content changes, but some content was updated to account for recent work in other commits, e.g. GitLab issue templates for new event requests. Additionally, the structuring of all event pages was drastically changed by introducing the use of Antora partials for creating reusable content.

Props to @nmilosev for bringing attention to the outdated documentation and @pbokoc for calling that this would happen some time back. 😉

Content changes

  • Use 2023 GitLab issue template URLs for event request instructions.
  • Better explain what is considered a recognized vote by a Mindshare Committee member.
  • Eliminate cross-links to the Advocate Program, which is not well- documented and has not been reviewed since 2018/2019.
  • Provide accepted methods for how to share an event report. The methods remain the same, but they were suggested/recommended before. Now, this makes it more clear that only methods are accepted as valid.

Introduction of Antora partials

The method of how the event request pages are composed is totally different. Now, there is minimal copytext included on the event request instruction AsciiDoc source pages. Instead, most of the content comes from a library of reusable partials. These are reusable pieces of content that can be embedded onto multiple pages at once.

So, where the steps remain identical across event request processes, they are applied consistently to each page. This means less content is being duplicated in more places. There is one source of truth, and when it is changed, it is reflected immediately on all pages.

For the parts of the processes that are different (e.g. ticket templates and voting policies), separate partials are used.

The motive for making this change is to make our documentation easier to maintain. If we propose future changes to the process, it will be easier to make sure our language is consistent and that the documentation does not contradict itself.

Merge request reports