This is a proposed project for Outreachy

One-line name:

Enable CI/CD of content to Fedora docs site

Longer description of project:

Docs.fedoraproject.org uses Antora to render asciidoc. The current system has no proper way to identify a PR (no preview) restricting maintainers to merge PRs on time, forcing contributors to set up Antora on their local system and there is always a danger of merging broken links or wrongly formatted texts. Contribution to the docs can take some time to get used to by a newcomer, often interested in fixing docs while exploring the projects. Fixing this issue will enable proper documentation workflow and a good documentation is one of the most important foundation of any projects.

License of the project

Mozilla Public License Version 2.0

Longevity (How long has the team accepted contributions):

Always (16+ years)

Community size:

10,000+

How will this project benefit Fedora:

Fedora docs will be more stable and contributors/users will have a better experience

Sample plan of work for the 12 week internship. What are milestones the

intern should be hitting? This doesn't need to be incredibly detailed and
can change later but there needs to be a general breakdown of tasks:

• Week 1 - 2: Get familiar with:
  • How Fedora docs is setup (Antora build, docs UI, templates etc)
  • Include the Logo in local resources
  • Add the common footer seen on other Fedora pages
  • Visual distinction and location of the table of contents Improve build script
• Week 3: Come up with roadmap/workflow on Preview the PR/build function
• Week 4 - 8:
• Openshift for CI integration
• Build a preview of the docs in openshift upon new PR being opened on any of the docs repo
• Week 10: Deploy to staging/production
• Week 11: Create a new toddlers in (https://pagure.io/fedora-infra/toddlers) checking every week for dead-links in the documentation and reporting them by email.
• Week 12: Wrap up, document work and outcomes

Benefits to intern (What will the intern get out of this internship):

• Discovering the Fedora project
• Discovering the Fedora community
• Work in a FOSS community
• Learn about openshift and containers
• Learn about building documentation website through antora
• Learn about considerations to have with internationalizations (multi-languages set-up)
• Learn about CI/CD principles

Project website:

https://docs.fedoraproject.org

Project repo:

https://pagure.io/fedora-docs/fedora-docs-ui

Where can an applicant find application tasks?

https://pagure.io/fedora-docs/fedora-docs-ui/issues

IRC

• #fedora-docs@Freenode.irc.net

Skills required including what level and if they are optional:

• Prior openshift or container experience would be nice
• Prior knowledge of python and asciidoc would be good

Outreachy applicants are required to make a contribution as part of the application. What is the process for making a contribution?

• Create a FAS account
• Subscribe to the docs and infrastructure list :
• https://lists.fedoraproject.org/archives/list/infrastructure@lists.fedoraproject.org/
• https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org/
• Introduce yourself to the team! (On the mailing list & IRC)
• Identify issues and send PRs
• Build the documentation website locally

Questions from the top level Outreachy Program for the mentor application:

Mentor(s):
* @pingou

How long have you been contributing to the community:

13+ years

What is your current role:

Fedora Infrastructure team lead

Have you mentored for a three-month internship program before:

Yes

Have you read the mentor page and understand the process of being a mentor:

Yes

Are you available for 5 hours a week during the internship period:

Yes

Are you available for 5-10 hours a week during the application period:

Yes

Are you aware you need to sign a mentor contract:

Yes