Tag Archives: handbook

Benjamin Evans 5:29 am on July 8, 2023
Tags: handbook,   

Next steps for GitHub updates

Summary: This post gives a brief overview of what updates have been introduced to the team’s GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ project management system so far, and outlines the next updates being planned. If you’d like to get involved with the next round of process updates, please comment below 😃

Updates so far

The Training Team migrated its project management tool from Trello to GitHub in early 2022. Since then, different updates have been implemented to the team’s project boards. These have included:

  • Making use of GitHub-specific tools
  • Creating entirely new projects for new processes (such as content localization)
  • Ensuring current processes enable the growing number of contributors in the team to effectively contribute to the team goals
  • Triaging the backlog of issues accumulated from TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. days

The team handbook now also has documentation regarding the team’s GitHub repository structure, and step-by-step guides for different team processes that use GitHub. These can be found on How we use GitHub and its child pages.

Current issue – checklists

Training Team processes have relied on checklists for a long time. However, due to the way access is set up in the WordPress GitHub organization, GitHub checklists can generally only be ticked by those who added the checklist to the issue. This has made it difficult for multiple contributors to effectively collaborate on a single issue. The checklists added to issue templates have been somewhat ineffective, as the person who submits an issue is in many cases not the person who will actually work on the issue.

To get around this issue, an idea was brought forth to move GitHub checklists into the handbook, and direct contributors to copy-paste the checklists into GitHub issues when they work on an issue. This update has been implemented into the following administrative processes, and has received positive feedback so far.

Next steps

It’s time to make similar changes regarding checklists to content development processes next. Here are specific tasks that need to be completed:

  • Move checklists currently in content development issue templates into the handbook as markdown text which contributors can copy-paste as needed
  • Update issue templates and project interfaces to link to the respective handbook entries
  • Audit handbook entries around content development processes and update to reflect the new GitHub setup

Additionally, the team’s GitHub repository currently has 114 labels, of which 20 are not being used on any open issue. I suggest we audit the current list of labels and make sure they match the current processes and tracking needs in the team.

I will be able to start implementing these updates from July 31st, and am looking for one or two other volunteers to collaborate with. If you would like to get involved, please comment below, and I’ll discuss next steps with you!

Final thoughts

Switching project management tools is not an easy feat! I appreciate the efforts of Training Team members before me who got this work started.

The team also has a desire to implement automations into the GitHub repository to automate some of the manual processes. If you have experience with GitHub automations, and would like to help implement those into the team’s repository, please comment below.

#handbook, #process

Aurooba Ahmed 6:05 am on June 12, 2019
Tags: , handbook,   

Recap for Training Team Meeting June 6, 2019

Attendance: @juliekuehl, @jessecowens, @iwritten, @man4toman, @kartiks16, @mukesh27, @aurooba, @viitorcloudvc, @chetan200891, @lisa

Slack timestamp

Learn siteLearn site The Training Team publishes its completed lesson plans at https://learn.wordpress.org/ which is often referred to as the "Learn" site. update

@chetan200891 merged several pull requests that added the following new templates to the Learn site betaBeta A pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process. theme:

If anyone else wants to help out with the development of the Learn site, there are clear issues with help wanted labels in the Learn site GitHub repository that you can ask to be assigned to.

@aurooba has a pull request almost ready to publish that will add a README file to the repository that shows potential contributors how to set up a local installation so they can properly contribute to the theme.

@juliekuehl: It’s going to be great to have a beta site to show to contributors at WCEU. It will help them understand how their work fits in.

@aurooba wants to discuss the transition to SCSS from CSSCSS CSS is an acronym for cascading style sheets. This is what controls the design or look and feel of a site. the next time @chetan200891 is available during the meeting as well – it will help with modularity and collaboration.

@chetan200891 is planning on adding responsive styling to the templates soon, it doesn’t currently exist. Also brought up the issue of lack of authentication fields on the Submit Lesson Idea page, and recommended that either the submitter be required to include their WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ username or email, or both.

@juliekuehl also suggested we add an area for objectives and recommended @chetan200891 go ahead and add these fields to the template.

@jessecowens has been working on the markdown importer implementation and the Custom Post Types code but would love help from anyone who’d like to assist.

Currently, @jessecowens is trying to get the manifest.jsonJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. script perfected reliably for the markdown importer implementation.

Slides Style Guide update

@Janet357 made some comments on the TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. card

@juliekuehl added some information to the Slides Style Guide page in the handbook and @jessecowens is planning on getting a video up today possibly.

WCEU Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/.

The folks from the Calgary Contributor Day came up with a great list of workshops based on the ideas in this post (workshops are detailed in the comments), so the next step is to decide on a workshop to focus on as a team and tackle that during WCEU Contributor Day.

@jessecowens and the communications team came up with the following snippet for the day:

The training team has identified several workshops– series of lesson plans for a specific audience/learning outcome– and we’ll be doing a “Sprint” to complete one of them. The workshop we’ll be working on, Best Practices for WordPress-Friendly Layout includes the lesson plans Introduction to CSS, Web Fonts, Using the Theme CustomizerCustomizer Tool built into WordPress core that hooks into most modern themes. You can use it to preview and modify many of your site’s appearance settings., and Using Child Themes.

Everyone agreed that this is a good workshop to start with and as work begins on it, more lessons will probably need to be identified and created.

Once WCEU Contributor Day happens, we can set priorities for other workshops based on the experience and feedback from WCEU.

ZenHub now has the ability to break out other workspaces and this can be useful to narrow focus and not overwhelm people as they begin to contribute.

@juliekuehl: I’m going to work on making more digestible versions [of ZenHub Workspaces] that people can use to look for issues that they can work on. Which also means that there’s a ton of issues that could be added to lesson plans

screenshot of the workspace for WCEU Contributor Day

@jessecowens recommended making issues in these 4 plans to manage Contributor Day more easily.

Documentation will need to be created on how to get set up and use ZenHub if we want to use it during Contributor Day. @aurooba volunteered to kickstart the ZenHub documentation if someone (@juliekuehl volunteered) takes her through it once.

@juliekuehl: So right now there are only two “Workspaces” – the big, ugly master one and one called “Contributor Day” which is in preparation for WCEU. I can imagine adding a “New Contributors” workspace and then labeling the issues with the skills required to complete them.

Upcoming team meetings

@juliekuehl: WCEU is two weeks away and we will not have a meeting that week. So that would be 20 June. But we will meet next week (13 June) and be back again the week after WCEU (27 June)

Lesson plan assignments and updates

The WP-CLI lesson plan has been added to the team’s reposrepos The Training Team uses GitHub for working copies of lesson plans. You can find them at https://github.com/wptrainingteam. and is looking great!

#contributor-days, #handbook, #workshops

Aurooba Ahmed 2:58 pm on May 30, 2019
Tags: , , handbook,   

Recap for Training Team Meeting May 30, 2019

Attendance: @juliekuehl, @man4toman, @iwritten, @chetan200891, @aurooba, @Janet357, @viitorcloudvc, @jessecowens, @kartiks16, @iwritten

Slack timestamp

Learn SiteLearn site The Training Team publishes its completed lesson plans at https://learn.wordpress.org/ which is often referred to as the "Learn" site. Update

@chetan200891 worked on the Custom Metadata for the learn site, which can be found here.

Everyone’s comments and feedback are encouraged. For those contributors, who would like edit access, please reach out to @chetan200891.

Getting Started Info / Handbook Update

@juliekuehl made significant progress on cleaning up and streamlining the Getting Started info in the Training Handbook to make it leaner and clearer.

@iwritten went through it today to learn and found it very helpful, so that’s good feedback!

The new glossary tool is activated on the Training Team blog, if there are other definitions anyone wants to suggest, please let @juliekuehl or another team member know!

@aurooba shared the open source plugin link for anyone who may want to take advantage of the feature.

@juliekuehl: I believe that the Handbook could still use some work around our actual workflow processes, but with the Learn site still in development some of those may be changing which is why we haven’t documented those just yet.

@jessecowens noted that there should be more videos and a lot of people concurred.

The move to ZenHub from Waffle.io for GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ project management also impacts the workflow, and there are a lot of new features that can be taken advantage of. This will also need to be documented.

Style Guide update

@janet357 worked on the Style Guide and made good progress! The more comments and feedback on Handbook Information the better!

Workshop focus / Calgary Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/.

Reference: https://make.wordpress.org/training/2019/05/25/a-small-shift-in-focus/ (and the comments!)

The Calgary Contributor Day contributions included brainstorming and fleshing out outlines for 8 potential workshops targeting different audiences that the Training team could work on.

@juliekuehl noted a lot of lesson plans that were included are in various stages of development and completeness.

@Janet357 mentioned that the next is step is to decide which workshop to start on and list the lesson plans to be used. These become top priority.

@juliekuehl: So, what I’d like the team to do at this point is to think about those suggestions and make comments as to whether or not they think they are the right ones or if there are others that should be included. Then I’d like us to get down to the specifics of choosing a workshop to begin with and decide which lesson plans would be a part of it and build those out. Then we could move on to the next workshop. Basically do sprints to get a workshop built out.

@aurooba volunteered to create TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. cards for each workshop that has been suggested after she’s given access. @juliekuehl will also make an “Other Workshop Ideas” Trello card.

Everyone should comment on the Trello card for the workshop they feel can be one of the first ones to work on.

WCEU Contributor Day

If everything can be put in place in time for WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Europe, the aim is to do a couple sprints on workshops to get them fleshed out and completed. Beginner workshops will take precedence and will likely be the first few to be fleshed out and completed.

@juliekuehl and @jessecowens were thinking if it’s possible to also do a sprint on the learn.wordpress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ there too with the help of another team.

@aurooba suggested that the tasks left for the website be added to GitHub. @juliekuehl will go through and create issues (in the repository https://github.com/wptrainingteam/learn-theme-beta) for all the tasks noted in the Trello card (https://trello.com/c/HgCQ6Jlp). @chetan200891 also felt that getting help from a different team would be helpful!

Lesson plan assignments and updates

A repository was created for the WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ lesson plan that @tristup created, now it just needs to be submitted using a PR request by @tristup to https://github.com/wptrainingteam/wp-cli.

There have been a few pull requests. Some of these still need to be reviewed and a few more have come in since the last queue clean out.

The team focus is coming back to including lesson plans, and the plan is to focus intensely on them after WordCamp Europe.

Open announcements/discussion

@chetan200891 shared GitPod, which is an online IDE for Github, that is easy and fast to use. You can work directly on Repo. Edit, Preview and Submit PR. It’s free for open sourceOpen Source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL. projects! He made a video on how to work using it: https://www.youtube.com/watch?v=xmCEyyzctbk.

@juliekuehl mentioned that this may become the recommended way to work on lesson plans for the Training team and contributors. She’ll add the video to the Getting Started section in the Training Handbook.

Action Items

Tasks without a specific person assigned are for anyone who’d like to contribute.

#contributor-days, #feedback, #handbook, #workshops

Courtney Robertson 8:13 pm on January 3, 2019
Tags: handbook, ,   

Notes on January 3, 2019 Meeting

Slack Log (Requires SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. login to view. Set one up if you don’t have a Slack account)

Welcome and Meeting Outline

  1. Handbook Updates
    1. Revising the Style Guide
      1. Examples displayed should be relevant to GithubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ formatting
      2. Slides style guide wasn’t functional as the slide display tool was discontinued. Suggest moving to https://pages.github.com/ . 
      3. @juliekuehl will update this page.
    2. Add tasks for semi-annual handbook updates to our team TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. board.
      1. 2 weeks before time changes begin, communicate about if the meeting moves times.
      2. Update a few places on the handbook displaying meeting times
      3. Update annual team goals
  2. Videos
    1. @jessecowens has been working on editing the atom video with some updates. He expects both the atom video and the one on slides to be complete by end of January
  3. Learn.WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/
    1. The Design Team is still working on re-doing the design based on the recommendations of the metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. team.
  4. Lesson Plans
    1. Regrouping about what lesson plans are in process next week to get more ready for the relaunch of the Learn siteLearn site The Training Team publishes its completed lesson plans at https://learn.wordpress.org/ which is often referred to as the "Learn" site.
    2. Possibly conduct a video meeting to brainstorm regrouping on lesson plans.
    3. Work with Kids Camps for workshop plans
    4. Repo Maintenance Labels for tagging lesson plans
      1. @courane01 will brainstorm ideas this week to be reviewed next week (January 10) and finalized on January 17.
      2. These will be part of the lesson plan submission process
    5. Meeting Wrap Up and Next Meeting Next meeting on 10 Jan 2019

#handbook, #slides, #videos