The Documentation Curators

Mission:

We help you succeed using your favorite CMS by curating the Umbraco documentation and making the process of contributing to the documentation simpler, friendly, and social.

Focus areas:

  • Umbraco CMS documentation
  • Responsiveness and recognition
  • Structure, processes, and guidelines
  • Highlighting activities to Umbraco communications team for cross-channel promotion

Goals

  • Ensure pull requests related to the Umbraco CMS documentation get handled in a timely manner
  • Provide and maintain clear structure of the documentation articles
  • Maintain contribution guidelines
  • Help and encourage new contributors to the documentation
  • Retain contributors
  • Maintain dialog with HQ Dev Team to ensure mutual awareness of relevant documentation issues
  • Minimizing number of Dev Team referral

Success criteria

  • Every pull requests is answered within 48 hours
  • Recognize all pull requests related to the Umbraco documentation
  • Increase in returning contributors year by year
  • Dev Team referrals are triaged by Dev Team within 48 hours (during business days) and then resolved within 5 weeks

Main activities

  • Maintaining the process for dealing with incoming pull requests to the Umbraco CMS documentation
  • Managing the Umbraco Docs Issue Tracker - triaging, labeling and verifying
  • Engaging with, onboarding, and coaching new contributors
  • Bi-weekly meetings (fortnightly) - Discuss the current state of the documentation repository, potential improvements, and plans going forward
  • Writing and publishing follow-up and updates blog posts on umbraco.com, including reporting on relevant metrics
  • Participating in and organize hackathons, panel discussions, meetups, and conferences/festivals to assist new contributors, talk about the structure of the team, achievements, and future goals
  • Identifying potential new documentation curators
  • Creating webinars for new and existing contributors
  • Creating content for and maintaining documentation-related sections on our.umbraco.com
  • Maintaining and expanding on the Documentation styleguide rules
  • Monitoring mentions of the Umbraco Documentation on e.g. Forums, Slack, Twitter

Internal Communication

  • The team uses a dedicated Slack channel to communicate, and the issue tracker to comment and follow-up on tasks. In-person meetings are scheduled twice a year:
    • May - Around Codegarden
    • November - Team visit to HQ

Getting in touch with the Team

  • To ask questions or share remarks specifically about the documentation, the Issue Tracker is the recommended channel to use.
    • For those who don’t have a Github account, they can send an email to docs@umbraco.com
  • To ask questions about the Documentation Team, the work we do and how we do it, use docs@umbraco.com or Tweet at us using #umbracoDocs or our individual twitter tags:
    • @sxfie
    • @crumpled_jeavon
    • @dampeebe
    • @marcemarc

Joining the Team

  • An online application will be open when there is a permanent vacancy
  • Apply for 6 month Curator Internship - applications open twice a year (see below for more details)

Curator internship

  • Time limit: 6 month
  • Applications twice a year (March / September)
  • Open to anyone
  • Participating in curating the documentation, e.g. reviewing PRs, discussing issues and joining the bi-weekly (fortnightly) meetings
  • Working on a dedicated project matching the interns experience and interest, supported and mentored by the Curators, e.g. the “Getting Started” section or “Examine”
  • Benefits
    • Featured in “Introducing Spring / Autumn intern” blog post
    • Learn how to contribute to Umbraco using Github
    • Learn Umbraco good practice in unique way
    • Discuss Umbraco implementation with experienced Umbracians and Umbraco HQ
    • Be involved!

HQ support and role

  • Ensure transparency and visibility
  • Provide coaching and training
  • Provide financial support for travel and accommodations to participate in meetings and events

Current team members

Structure

  • The team is ideally organized as a group of no more than 6 members:
    • 1 HQ employee - Steward
    • 3 community volunteers
    • 2 interns (community or HQ)

With a team lead, Steward, in the center, the team is organized around fulfilling different roles according to the skillset and preferences of each.

The Steward’s role is focused on

  • Managing the team
  • Providing the necessary support to the different members
  • Coordinating with the HQ Dev Team and the stewards of the other community teams

 

First version. Published in November 2019. Updates will follow.