#245 2023 docs refresh: Update metadata, links, & meeting information
Merged by jflory7. Opened by jflory7.
jflory7/fedora-diversity change/2023-refresh  into  main

Download 245.patch

This commit is a significant refresh of the Fedora DEI Team docs based
on our current best practices and team workflows, as described below:

Update attributes

This was the largest change made to the docs. Our attributes file was
updated, in response to feedback that the links to our Fedora Discussion
pages were broken after the recent change from #dei to #dei-team.
There was not advance notice made to the team about this change, so the
links are now broken and need to be updated so people are directed to
the correct place for our discussions.

While doing that, I pulled the template file from the Engineering and
Mindshare docs maintained in the Council docs repository to use as a
model. I updated our platforms from the template and then used the
attributes as much as possible throughout our docs. There is more work
to do, but in the future, this will make metadata updates easier. There
will only be one place to update URLs should they ever change in the
future.

Refresh index page

  • Remove mention of podcast interview because the link is now offline.
  • Change ticket tracker mentions from Pagure to GitLab.
  • Drop mention of the mailing list and point to Fedora Discussion tag.
  • Update information on where to find the team to just use Discourse and
    Matrix; we should try to funnel people to the places where the team is
    most active and connected to the rest of the Fedora community.
  • Reframe the platforms on where to find us as "synchronous" and
    "asynchronous" instead of using platform names.

Refresh getting involved and meeting guide pages

  • Used more xref's to external team documentation where applicable
    (e.g. Fedora Legal and Fedora Infrastructure).
  • Update context of our communication platforms to not mention mailing
    list or Telegram group as primary ways to engage with the team.
  • Drop Pagure in favor of GitLab for ticket-based task tracker.
  • Fix formatting and minor flow improvements for explaining how to
    become a sponsored member of the DEI Team.
  • Add social agreement and meeting format from the HackMD notepad.

Miscellaneous changes

  • Per discussion with @mattdm and low-visibility users on Fedora
    Discussion, stop using punctuation marks to distinguish acronyms. This
    was originally done for the benefit of screen reader users, but this
    guidance is now out-of-date with how most screen readers work, based
    on community feedback.
  • Change "Fedora Women's Day" to "Fedora Week of Diversity" where it was
    not already changed.
  • Stop using :toc: attribute in pages, since the Fedora Docs theme now
    includes a table-of-contents in the sidebar by default.

rebased onto 4fcddeacfe020d427e35ae3544fc03ac5891c2a3

Metadata Update from @jflory7:
- Pull-request tagged with: improvement, type - docs

rebased onto 47106122e7015f36a0122407581f0ec54248c927

+1
Thanks @jflory7 and good job!

'don't be shy' feels a little ..hm...cold? to those for whom a self-introduction is actually a big step. Maybe bit of wordsmithing here to acknowledge that might help. Case in point, I'm a drive-by commenter and have been lurkin in the channel on matrix for ages.. probably never would introduce myself....

It will be helpful to give specific details? Like how to talk to a member? How to check who all are active members of the team?

1 new commit added

  • PR #245: Address @samccann and @amsharma comments

@irdiis Thanks for taking a look! :thumbsup:

@samccann @amsharma Thanks for your feedback. I pushed commit 908c086e28ce3f78543064945e1d015b7920e6aa which I believe addresses your comments.

I am going to rebase and squash my commits, and then merge this so it can get built before the end of the week.

rebased onto be31805539df5c533ad5beee6ad48eb64521efcb

Pull-Request has been merged by jflory7

Thanks @jflory7 - reads much better now!

Metadata