[Outreachy 2024] Create a Fedora Docs site for the Accessibility Working Group
Summary
Create a new Fedora Docs site for the Fedora Accessibility Working Group to help them promote their work and message.
Background
Fedora has an Accessibility (a11y) Working Group, which focuses on accessibility technology in Fedora. This is a new Working Group (WG), and like many teams in Fedora, they need a place to publish their own documentation. We have a documentation website, where several teams and projects publish new information. We want to create a new docs site for the Accessibility WG.
Some knowledge of git is required to do this, as you will need to make Merge Requests to two GitLab repositories.
The ask is not about content creation, but instead about setting up a community tool that another team can use to be successful. By working on this issue, you will improve your collaboration skills using git, learn a bit about AsciiDoc and Antora, and how the Fedora Docs site is built.
Details
This task might be challenging, so have patience and reach out to the project mentors if you have questions!
- Set up your environment. You will need to install git and either Podman or Docker to run a container. If you are on Windows, it may help to use the Windows Subsystem for Linux, so you can have a standard command-line environment to build and test things out.
- Clone the template repo. This repo is a generic template that can be used to create a new Fedora Docs site. You can clone the repo to your local machine, and then copy it over later to the Accessibility WG repo.
-
Clone the Fedora A11y WG repo. Once you clone the repo, make a new folder in the repo called
docs/
. Copy the files from the template repo into this folder. - Edit the Antora files and config files for the A11y WG. Use the Fedora DEI Team Docs repo as an example to follow.
- Make a Merge Request with the template to the Fedora A11y WG repo. From here, I will review the Merge Request and provide feedback. Expect to receive some feedback and some tweaking on your changes before the Merge Request is merged.
- Open a new Merge Request to the Fedora Docs builder repo with the details for the new Fedora Docs site. Completing this step is what will get our Docs site to build the new repository and start publishing the docs.
Note that the URL we expect to use for this is https://docs.fedoraproject.org/en-US/a11y/.
Outcome
The Fedora Accessibility Working Group has a dedicated docs site to publish their team information and key information.