Documentation landing page CTA (Call to action) - Your feedback is important

Hi folks,

Could I make a suggestion to improve onboarding experience for Docs contributions in light of the new 3.0 site?

Issue

There are several Docs links to the documentation landing page scattered throughout the new 3.0 site. Contributors find it difficult to find ‘how to get involved’ because Docs team page, README, wiki have discrepancies in joining instructions.

Expected result

  • Contributors see clear signpost on the landing page, so they quickly find tasks that suit their interest and expertise, regardless of long-term time commitments.

  • Bypass or remove intermittent steps (microsite, SIGs, other communication channels) before contributors get to work

  • More commits and PR review for collaboration

  • Raise more awareness on Documentation contributions

Solution

  • Putting call-to-action (CTA) links on the documentation landing page for role-based ‘Join us’ messaging
  • Link to each UI text for CTA and link

Write a new how-to-guide or tutorial

Do technical review

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

QuickDocs has 87 pages to maintain and needs expert technical review on a regular basis. We need subject matter experts to examine the content for technical accuracy and up-to-dateness.

Improve user experience

Note: This page requires a major update by UX specialists. The vast majority of issue/MR in GitLab Docs repo comes from UX improvement, mass update (CSS, AsciiDoc attributes), and automation (CI script).

Issue ticket here for your feedback

New Docs logo

fedora-docs

I agree that information discovery about contributing is difficult from the current Docs homepage. It can take many clicks to find someone is looking for, and a more generic entry-point would be easier than exploring each team in individual detail.

I see the changes you propose here as more specific to Fedora Docs. Is this your intention, or do you think something more general for all of the Fedora community would be better?

Since I entered my role at Red Hat, I quietly established the below docs site and have added things there bit by bit. I wasn’t sure if I wanted to keep it or not yet. Perhaps this could be a chance to figure out a bigger purpose for the site:

2 Likes

Yes, what I posted here is Docs specific (Docs homepage and user documentation like QuickDocs) request to make ‘how to contribute to Docs’ visible in the new website. I’ve broken CTA down to three types of contributions.

I took the idea from ‘email subscription’.

Back to your observation on CommArch documentation page,

I slowly realized the overarching function and team in the Fedora project thanks to you. CTA (Call to action) approach could be too much task-oriented, but it measures effectiveness of our efforts and user journey on our website. Just nitpick on the participation process of CommArch is “Phase 0 - bootstrap” sounds loftier than necessary.

I reckon almost each project team has its tweaks on joining instructions (or onboarding). Sometimes, I got lost in going through all kinds of joining process, request to access or special permissions (commits and so on). To me, a simple joining process appeals to me. That’s why I joined Magazine team within two days after installing my first Linux desktop. CTA (how to contribute to Magazine) was right in front of the home page when I opened up Firefox.

2 Likes

Do you think content about the Fedora community, its history, and stories/milestones is useful content? Why or why not?

I still have to figure out that whole onboarding path thing. I fell back on it because one pathway feels very rigid for what someone can do in Fedora. Maybe there need to be different contribution pathways that can go in different directions.

I think this will be a separate topic from here, but I’ll keep this one in mind with the Community Ops discussion happening over here:

Yes, it is useful. Fedora Join sends out the links about introduction to Fedora projects. It helps prospective contributors (it did to me as well) to explore the community and get to know people and pathways. They may not read all of them, but find a right task that suits their interest and expertise or opportunity to learn by doing.

1 Like

Yeah, I agree, we need to improve and strengthen our onboarding efforts. And CTAs may be a good way.

Then my first thought was: where to put it on the Docs home page? On the one hand, the design is somewhat ancient nowadays. On the other hand, it allows a large amount of information to be presented clearly. But it is a bit inflexible, and offers hardly any possibilities to include CTAs.

Second thought was, then, wouldn’t it be better to include CTAs systematically on the editions and spins pages? There, the design also offers better options. You could do it similar to Fedora Magazine.

In any case, we should think about it. This is an urgent topic.

There are three well-trodden paths to join Fedora project sub-groups or SIGs;

joining

  • Join SIG on the new contributor menu: Join SIG onboards prospective contributors in Welcome To Fedora, which gives them time to introduce them to the community and get to know each other.

  • Role-based CTA: https://fedoramagazine.org/

These paths are sign-posted clearly. I’m not suggesting to unify these well-known paths. I think we need to do “how to join” messaging with How to join Fedora resources on the right location in the new website. This is consistency we need.