Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Team roles - new Documentation team handbook page #385

Closed
1 task
zzap opened this issue Jul 18, 2022 · 23 comments
Closed
1 task

Team roles - new Documentation team handbook page #385

zzap opened this issue Jul 18, 2022 · 23 comments
Assignees
Labels
contributor documentation new document Requests for new page/article.

Comments

@zzap
Copy link
Member

zzap commented Jul 18, 2022

What is the new page you are requesting?

The page that will hold description and responsibility for each team role in WordPress Documentation team.

How will this new page help you?

It will give clear(er) insight to all documentation contributors about the roles they can take on and ways to contribute to WordPress documentation.

@zzap zzap added the new document Requests for new page/article. label Jul 18, 2022
@zzap zzap self-assigned this Jul 18, 2022
@zzap zzap added this to To do in Documentation team Handbook via automation Jul 18, 2022
@zzap
Copy link
Member Author

zzap commented Jul 18, 2022

Team roles

Per responsibility:

  • Team reps (representatives)
  • Project reps
  • Contributors

Non project roles:

  • Facilitating
    • Meetings
    • Issue triages
  • Writing meeting notes
  • GitHub issues coordinator
    • Reviewer
  • Onboarding coordinator
  • Contributor Day facilitator

Project based roles:

  1. Design
  2. End user
    • General
    • Block editor
    • Feedback curator
  3. Theme handbook
  4. Plugin handbook
  5. Common APIs
  6. Code reference
    • More Info curator
    • User Notes curator
  7. Block editor developer
  8. Advanced administration
  9. Docs team handbook

@zzap
Copy link
Member Author

zzap commented Jul 18, 2022

Meeting facilitator

Responsibilities:

  • Post the agenda on the “Make Documentation” team blog.
  • Lead the bi-weekly team meetings in Slack.

How do I do this job?

  • Post the agenda in the Slack channel before the meeting (preferably several hours before). Writing agenda.
  • Lead the discussion of the agenda in the Slack channel. Facilitating meetings.

Examples of previous agendas: https://make.wordpress.org/docs/tag/agenda/

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Jul 18, 2022

Note taker/meeting summarizer

Responsibilities:

Take notes during weekly meetings and post them on the “Make Documentation” team blog.

How do I do this job?

  • Take notes during (or after) the meeting.
  • Post the minutes on “Make Documentation”.

Examples of previous summaries: https://make.wordpress.org/docs/tag/summary/

Recommended onboarding sessions:

@zzap zzap moved this from To do to In progress in Documentation team Handbook Jul 19, 2022
@zzap
Copy link
Member Author

zzap commented Jul 20, 2022

Project rep (representative)

A Project rep is a person who takes responsibility for the Documentation team’s projects, in parts or in whole.

This means that this person is a go-to person for all new contributors on the project. Also, a rep is monitoring progress of the project, or its parts, and reports on it during team meetings.

One person can be rep for one or more projects but also can be rep for one project and contributor for others. There is no limit to the number of reps per project. The more people take responsibility, the less pressure on one person there is.

Representative is a team member; one performing the role has both Documentation badges, contributor and team.

Anyone who is interested in becoming a rep can ask the appropriate rep for the project to be included or ask directly one of the team reps in Slack.

Responsibilities:

  • Monitor and perform work on GitHub issues for their project.
  • Guide contributors who want to help with the project.
  • Update project documentation based on completed work in GitHub issues.
  • Report on project progress at the Documentation team meetings.
  • Recruit and onboard new contributors for the project.
  • Plan and organise work and improvements of the project.
  • Make sure project contributors receive their Contributor badges.

How do I do this job?

  • Connect with and onboard contributors who expressed interest in helping to the project.
  • Monitor GitHub issues for their project or projects. Label them when applicable.
  • Work on those issues or guide contributors working on them.
  • Review work of other contributors and guide them how to improve it if necessary.
  • Update documentation in their project once the work inissues is completed; or guide other contributors in updating the docs.
  • Post the list of completed or in progress GitHub issues at the Documentation team meetings - Project updates agenda item. Also, mention contributors working on those issues.
  • Create a list of contributors who should receive Contributor profile badges and post it at the Documentation team meetings - Project updates agenda item.
  • Organise work on the project (priorities, good first issues etc) and develop a plan for improving the project if the room is found. Always keeping the interest of documentation user as the top priority.

All Project reps have earned their Team badges by performing these contributions. Badges are manually added so if you have contributed to the Documentation team but don't have one, please contact one of the team reps. Read more about the Documentation team profile badges.

Recommended onboarding sessions:


Related #639

@zzap
Copy link
Member Author

zzap commented Jul 20, 2022

GitHub issues coordinator

Responsibilities:

  • Monitor all new issues created in GitHub repository and label them appropriately. Monitoring can also be done in #docs-firehose Slack channel.
  • Assign contributors who express the interest to work on the issue.
  • Welcome assigned contributors with information about the docs project the issue belongs to: who is the project rep, onboarding docs/video for the project if exists, and where to go to ask for help (meeting time and place).
  • Check project boards and make sure issues are in appropriate columns (Todo, In progress, Review, etc)

How do I do this job?

  • Subscribe to issues for the repository and review every newly created one. Apply appropriate labels (should be familiar with all docs projects and their labels).
  • Assign interested contributor to the issue. Contributor needs to post a comment on the issue, expressing their interest to work on the issue (otherwise we can't assign them - GitHub settings).
  • Post a comment with following info (these could be premade templates):
    • Thank contributor for volunteering to work on the issue.
    • Username of the project rep or any other person responsible for reviewing the work and helping if needed.
    • Link to onboarding section in team's handbook (for project if exists).
    • Information about the next Docs team meeting (time, date and place) where contributor can ask for help and/or report on progress.
  • Move issue to appropriate project column (In progress, Review etc) where applicable.

This role is complementing Issues triage facilitator and GitHub issues reviewer roles. Roles can collaborate and/or be performed by the same person.

Recommended onboarding sessions:


Related #640

@zzap
Copy link
Member Author

zzap commented Jul 26, 2022

Onboarding coordinator

Onboarding process can last anywhere between 7 days and 4 weeks, depending on contributor's prior knowledge, skills, and experience. During this period potential new contributor should learn about documentation projects, team members and other contributors, and all the ways in which they can contribute to the Documentation team. It is not mandatory to attend Documentation team meetings (time zones can be difficult) but it is advisable, for all members of course.

During onboarding period new contributor can start contributing by facilitating the meeting or writing meeting notes. These are great ways to meet the team and get familiarised with all the projects and current priorities. If desired, new contributor can start contributing with other tasks as well.

Responsibilities:

  • Welcoming new people in #docs Slack channel.
  • Introducing all Documentation projects to new contributors and helping them find tasks that match their interest and skills.
  • Enabling new contributors to independently contribute to any documentation project after the onboarding period - in a way to know where to look for information and who to talk to in order to learn more.

How do I do this job?

  • Familiarise yourself with all documentation projects and their representatives - basically what we have in onboarding videos.
  • Greet all new members in #docs Slack channel and offer help with onborading.
  • Communicate regularly with contributors who expressed wish to contribute - at least once a week checking up on them and replying to all their questions meanwhile.
  • Mention members going through onboarding process at the Documentation team meetings - Project updates agenda item.
  • After onboarding period is completed, officially welcome new contributors at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Jul 26, 2022

Contributor Day facilitator

Contributor Days are usually organised as a part of WordCamp but can be standalone events as well.

It is NOT expected from Docs team Contributor Day Facilitator to organise the event. Docs team Contributor Day Facilitator is a person who represents the Documentation team at such event, organised by other people. In following description I will be using "table lead" term as it is more commonly used in WordCamp and Contributor Day vocabulary.

Responsibilities:

  • Presenting documentation tasks for the day, either to all attendees or just to the group of people who registered for the Documentation team (this depends on how organisers of the event want to start the day).
  • Basic onboarding for first timers - it is not unusual that people without wordpress.org accounts attend Contributor Days, for some it's their first contact with open source community. Basic onboarding covers creating wordpress.org, WordPress Slack and GitHub accounts.
  • Collect all wordpress.org usernames so that Documentation contributor badges can be added to their profiles.
  • Helping out contributors at the table and answering their questions, or directing them to a person who can answer the questions.
  • Gathering info about completed work during the day and presenting it at the end of the day (if organisers have this planned).
  • Reporting on progress made and new contributors at the following Documentation team meeting.

How do I do this job?

  • If you are attending a WordCamp check with organisers if there will be Contributor Day (this is usually announced somewhere on the website) and if they already have someone to lead the Documentation team table - it is not unusual to have more than one lead so you can offer to help out if they do.
  • Once you know you'll be leading the Documentation team table at Contributor Day, check with the Documentation team what could be good tasks for the day. This is best done at the Documentation team meetings - Open floor agenda item, but can be done anytime in #docs Slack channel if needed. You can also ping one of the team reps to help you out with this.
  • Contributor Day organisers will communicate with you about the schedule for the day and if you should prepare something - usually that's just list of tasks from previous item.
  • At the beginning of the day organisers will introduce all teams and their table leads. They might present the tasks for each team or they will invite table leads to do that for their team.
  • Do not hesitate to bring the cookies to bribe contributors. This is, of course, a joke. However... it's been tested and proven to attract undecided contributors and to have a certain impact in making the day more enjoyable and fun.
  • Help new contributors register all the necessary accounts (wordpress.org, WordPress Slack, and GitHub) and explain them the tasks they might work on. Explain the tasks to more experienced contributors.
  • Invite all contributors to join #docs Slack channel and communicate there anything regarding tasks they are working on.
  • Collect all the wordpress.org usernames so that we can give them contributor badges later.
  • Help contributors with any questions they might have. If you don't know the answer, ask in Slack channel and someone will answer it.
  • At the end of the day present the progress being done during the day (organisers will invite all table leads to do so in closing remarks). This doesn't need to be detailed, just some interesting statistics: number of new and total contributors, number of issues it's been worked on, number of closed issues, how this progress is helpful for WordPress documentation in general etc
  • Present this same statistics at the following Documentation team meeting - Project updates agenda item.

Contributor Day Goal

In general, Contributor Days are used for tasks that are, at the moment, higher priority for the team but also doable during the day so that all contributors can have a sense of accomplishment.

Some contributors just want to try out contributing to documentation, some want to keep contributing in the future and some contribute only during Contributor Days. Whichever the case, Contributor Day should be a pleasant experience where everyone feels welcome, enjoy the tasks and learning experience and, hopefully, decide to keep contributing in the future as well. It is table lead's job to create such atmosphere.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Jul 28, 2022

Issues triage facilitator

Responsibilities:

  • Lead the bi-weekly issues triage in Slack.

How do I do this job?

  • Prepare a list of urgent and/or abandoned issues found in Issue Tracker repo
  • Lead the discussion about selected and other issues brought up by other members attending the triage in the Slack channel.
  • Assign issues to contributors who express interest in working on issues.

This role is complementing GitHub issues coordinator role. Roles can collaborate and/or be performed by the same person.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 1, 2022

Team rep (representative)

Team Rep is a leadership role that is mostly administrative in nature; it is not a Lead role. Letting go of the Team Rep title is not a loss of status, just a handing off of responsibilities. Someone who is a leader in a team can lead whether they are doing the team rep job or not. [...] The primary Team Rep is responsible for posting a weekly update of the team’s activity to the make.wordpress.org/updates blog, as well as raising any issues or red flags that other teams should be aware of or discussing.

Read more at official page.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 1, 2022

Contributor

Contributor is everyone who has ever contributed to the Documentation team by:

  • reporting an issue with any part or project maintained by the Documentation team,
  • fixing, in part or whole, an issue with any part or project maintained by the Documentation team,
  • submitting a code example to Code reference handbook,
  • performing any of the non project based roles,
  • attending the team meeting and participating in discussions, and
  • attending Contributor Day at the Documentation team table.

To get the most out of contributions, get recognition for contributions and help the team as much as possible, contributors working on projects are advised to closely collaborate with representative for the project. This is the best way to avoid working on something that is not priority or maybe won't even be used in documentation.

All contributors have earned their Contributor badges by performing these contributions. Badges are manually added so if you have contributed to the Documentation team but don't have one, please contact one of the team reps. Read more about the Documentation team profile badges.

Recommended onboarding sessions:


Related #639

@zzap zzap added 6.1 Changes in 6.1 release and removed 6.1 Changes in 6.1 release labels Aug 9, 2022
@zzap
Copy link
Member Author

zzap commented Aug 9, 2022

Theme handbook

Project code name: DevHub, Theme
Project URL: https://developer.wordpress.org/themes/
Project issues label: themes
Project issues URL: themes Issues for Theme Developer Handbook

Responsibilities

  • Work on Theme handbook issues in Issue Tracker repo, whether it's creating a new page or just fixing a part of existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labeled with themes label.
  • Communicate with Themes handbook project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, pinging any of the project reps.
  • Updating the page in handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Theme handbook documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 9, 2022

Plugin handbook

Project code name: DevHub, Plugin
Project URL: https://developer.wordpress.org/plugins/
Project issues label: plugins
Project issues URL: plugins Issues for Plugin Developer Handbook

Responsibilities

  • Work on Plugin handbook issues in Issue Tracker repo, whether it's creating a new page or just fixing a part of an existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labelled with plugins label.
  • Communicate with Plugin handbook project reps for any clarifications on the tasks and a review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
  • Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Plugin handbook documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 9, 2022

Common APIs handbook

Project code name: DevHub, Common APIs
Project URL: https://developer.wordpress.org/apis/
Project issues label: apis
Project issues URL: https://github.com/WordPress/Documentation-Issue-Tracker/labels/apis

Responsibilities

  • Work on Common APIs handbook issues in Issue Tracker repo, whether it's creating a new page or just fixing a part of an existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labelled with apis label.
  • Communicate with Common APIs handbook project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
  • Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Common APIs handbook documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 15, 2022

Design

Responsibilities

  • Review and maintain an accurate sitemap.
  • Create pattern templates for the articles.

How do I do this job?

  • Check with other project reps about new articles being published and make sure they are using the correct category/subcategory (link to the GH project coming)
  • Create pattern templates to be used when new articles are created.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 16, 2022

End user documentation - General

Project code name: HelpHub
Project URL: https://wordpress.org/support/
Project issues label: user documentation
Project issues URL: https://github.com/WordPress/Documentation-Issue-Tracker/labels/user%20documentation

Responsibilities

  • Work on end user documentation issues in Issue Tracker repo, whether it's creating a new page or just fixing a part of existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labeled with user documentation label.
  • Communicate with General end user docs project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, pinging any of the project reps.
  • Updating the documentation page/article is usually done by one of the project reps or active contributors who have access to the dashboard where end user documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 16, 2022

End user documentation - Block editor

Project code name: HelpHub
Project URL: https://wordpress.org/support/article/blocks/
Project issues labels: user documentation, block editor
Project issues URL: https://github.com/WordPress/Documentation-Issue-Tracker/issues?q=is%3Aopen+label%3A%22user+documentation%22+label%3A%22block+editor%22

Responsibilities

  • Work on block editor end user documentation issues in Issue Tracker repo, whether it's creating a new page or just fixing a part of existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labeled with user documentation and block editor labels.
  • Communicate with Block editor end user docs project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, pinging any of the project reps.
  • Updating the documentation page/article is usually done by one of the project reps or active contributors who have access to the dashboard where end user documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 16, 2022

End user documentation - Feedback curator

Project code name: HelpHub
Project URL: https://wordpress.org/support/wp-admin/edit-comments.php
Project issues labels: user documentation, block editor
Project issues URL: https://github.com/WordPress/Documentation-Issue-Tracker/labels/user%20documentation, block editor Gutenberg related issues , any of the version labels

Responsibilities

  • Regularly check on new Feedback (comments) being submitted to End user documentation, triage and create issues for them at Issue Tracker repo.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Regularly check new feedback/comments at end user documentation.
  • Delete spam and unrelated comments - anything that is not feedback on actual article (good or bad).
  • Create issue in Issue Tracker repo.
  • Label the issue with user documentation label, add block editor and any of the version labels if applicable.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Aug 16, 2022

The Documentation team handbook

Project URL: https://make.wordpress.org/docs/handbook/
Project issues label: contributor documentation
Project issues URL: contributor documentation

Responsibilities

  • Work on Docs team handbook issues in Issue Tracker repo, whether it's creating a new page or just fixing a part of an existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labeled with contributor documentation label.
  • Communicate with the Documentation team handbook project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
  • Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where the Documentation team's handbook documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Nov 22, 2022

GitHub issues reviewer

Responsibilities:

  • Monitor all issues marked for review. This is mostly for end user documentation and status can be seen in dedicated project boards. (E.g. 6.0 board, 6.1 board)
  • Monitor project board and make sure issues are in appropriate columns (Todo, In progress, Review, etc)
  • Review contributed content and/or media.
  • Follow the workflow for next steps (move issue to another column, assign other person, update article etc)

How do I do this job?

  • Check project boards and move issues to appropriate project column (In progress, Review etc) where applicable.
  • Review new content and/or compare it to existing article. Follow todo list and check each completed item.
  • Request changes/updates if applicable. Otherwise note in comment that everything is completed.
  • Some issues require two reviews. Depending on this following steps can be:
    • Move issue to next review column and ping other reviewers.
    • Move issue to Ready to publish column and ask contributor if they want to update the article themselves.
    • Move issue to Ready to publish column and update/create the article.
  • When article is updated, close the issue.

This role is complementing GitHub issues coordinator role. Roles can collaborate and/or be performed by the same person.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Feb 15, 2023

More information curator

Project code name: DevHub, Code reference
Project URL: https://developer.wordpress.org/reference/
Project issues label: code reference
Project issues URL: code reference Issues for Code Reference portal of DevHub

Responsibilities

  • Work on Code reference handbook issues in Issue Tracker repo, whether it's creating a new More info section or just fixing an existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labelled with code reference label.
  • Communicate with other More info curators for any clarifications on the tasks and a review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
  • Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Code reference documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.
  • An example of good and detailed More information section can be found on WP_Query class page. Everything between More information and Methods belongs to the More information section.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Feb 15, 2023

User contributed notes curator

Project code name: DevHub, Code reference
Project URL: https://developer.wordpress.org/wp-admin/edit-comments.php
Project issues label: code reference
Project issues URL: code reference Issues for Code Reference portal of DevHub

Responsibilities

  • Monitor User Contributed Notes in the Code reference handbook. These are, in fact, comments, pending approval.
  • Depending on the content of the note, the comment will be either published or trashed. More on this is below.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

  • Look for issues labelled with code reference label.
  • Communicate with other User contributed notes curators for any clarifications on the tasks and a review of your work. All questions can be asked in the #docs or #core-docs Slack channels, by pinging any of the other curators.
  • Updating the notes in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Code reference comments live. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for monitoring and updating the comments
  • Report on your progress at the Documentation team meetings - Project updates agenda item.
  • A lot of examples of User contributed notes can be found on WP_Query class page.

Guidelines

  • Code should strictly follow WordPress coding standards, and any output should be escaped and internationalised.
  • Any feedback about the documentation itself should not be published - these are processed as Trac tickets for the core team (e.g. https://core.trac.wordpress.org/ticket/56324)
  • Prefix all class and function names with wpdocs_
  • No support requests: immediately trashed
  • General “thank you” messages should not be published
  • The ultimate goal is for comments to be valuable, easy to read and follow best practices and coding standards. Code examples should work by copying and pasting, and if necessary, changing some things (e.g. taxonomy name, custom post type name etc.).

Possible workflows:

  • A user submitted a note reporting an issue with a DocBlock parameter:

    • Open a ticket on Trac (example)
    • Mention the commenter's WordPress username so they can get Core Props for the contribution
    • Trash the comment once the ticket is committed
  • A user submitted a note with a code example:

    • Check the formatting, escaping, internationalisation and prefixes.
    • Check if the code is working as expected (testing it in your local WordPress installation may be the best option).
    • If everything is correct, publish the comment. If issues are small (from the first item) fix them yourself. If the code is not working or even causing errors, try to contact the author (via slack) to fix the issues. If it is not possible to contact the author (e.g. they don't have a slack account) and you're not in a position to fix errors, ask other curators for help and leave a comment as pending. If no progress is made and the author hasn't contacted the team, trash the comment.
    • Inform the Documentation team of the username so that contributor can get their Docs badge.

Recommended onboarding sessions:

@zzap
Copy link
Member Author

zzap commented Feb 15, 2023

Advanced administration handbook

Project code name: DevHub, Advanced administration
Project URL: (doesn't exist yet) https://developer.wordpress.org/advanced-administration/
Project issues label: advanced administration
Project issues URL: advanced administration Issues for Advanced administration Handbook and https://github.com/WordPress/Advanced-administration-handbook/issues
Project repo: https://github.com/WordPress/Advanced-administration-handbook

The Advanced administration handbook is created and maintained in collaboration with the Hosting team. To contribute to the handbook you can contact either the Documentation or Hosting team.

Responsibilities

  • Work on Advanced administration handbook issues in Issue Tracker repo and Advanced administration repo, whether it's creating a new page or just fixing a part of an existing one.
  • Report on progress at the Documentation team meetings - Project updates agenda item.

How do I do this job?

Recommended onboarding sessions:

  • Overview
  • Once the handbook is published we'll record the onboarding session for it.

@zzap
Copy link
Member Author

zzap commented Feb 15, 2023

Block editor developer handbook

Project code name: DevHub, Block editor
Project URL: https://developer.wordpress.org/block-editor/
Project issues labels: developer documentation, block editor
Project issues URL: developer documentation + block editor and gutenberg/[Type] Developer Documentation
Project repo: https://github.com/WordPress/gutenberg/tree/trunk/docs

The Block editor developer handbook is created and maintained in collaboration with the Core team. To contribute to the handbook you can contact either the Documentation or Core team.

Responsibilities

How do I do this job?

  • Look for issues labelled with developer documentation and block editor labels as well as issues from the Gutenberg repo.
  • Communicate with Block editor end user docs project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue by pinging any of the project reps.
  • Updating the page in the handbook is done by merging the PR in the Gutenberg repo, performed by one of the committers. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to merging PRs after the review is completed, and content approved.
  • Report on your progress at the Documentation team meetings - Project updates agenda item.

Recommended onboarding sessions:

@zzap zzap closed this as completed Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor documentation new document Requests for new page/article.
Projects
Status: Done
Development

No branches or pull requests

1 participant