Where should we store documentation?

Welcome

The WordPress Training Team helps people learn to use, extend, and contribute to WordPress through learn.wordpress.org.

Are you new to the team?

Getting Started – Join the team through this self-guided onboarding program

Current Focus Areas – What we’re currently focusing on

Already onboarded and ready to get involved?

See How we use GitHub to get started on one of our 6 project boards

Meetings (Calendar)

You can join these meetings from the #training Slack channel:

Weekly meeting: Thursdays 00:00 UTC

Dev-squad 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/ triage: Thursdays 07:00 UTC

See Meeting Details for more information.

Right now the documentation is scattered about make.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//training. Some of it is in the regular navigational structure, but quite a lot of it is hidden within the P2P2 P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. blog. Especially as the team is currently focused on streamlining processes and inventing new processes for things that need it, we need a centralized place to keep all of our documentation.

After looking through all of the other Make sites, it seems that the other teams nearly universally use the handbook to store their documentation. Thus far, we’ve used the handbook to store lesson plans in progress only.

The questions we have for the team are:

What are the pain points with the current structure of where data is located on make.wordpress.org/training?
What needs do we have in terms of organizing documents and collateral for the training team?

Thus far we’ve identified some of the problems, but need to think through and determine if there are other issues that we haven’t considered yet. Finding a solution for this one will take some time and thought – please note any thoughts you have either on pain points (question 1) or team needs (question 2) in the comments below.

Note: This topic was initially discussed during our regular team meeting on September 29, 2015.

#procedures

bethsoderberg 5:54 pm on October 6, 2015
In the team meeting on October 6, 2015, we brainstormed the following:

1. What are the pain points with the current structure of where data is located on make.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//training?
- We are not easily able to find our stuff or know what stuff there is to find. – @juliekuehl
- Our main navigation menuNavigation Menu A theme feature introduced with Version 3.0. WordPress includes an easy to use mechanism for giving various control options to get users to click from one place to another on a site. contains some of this stuff… but doesn’t include what we’ve started to come up with for other things… like our new procedure for audits and contributor days. – @courtneyengle
2. What needs do we have in terms of organizing documents and collateral for the training team?
- We need to be able to find our stuff efficiently. – @juliekuehl
- If EVERYONE else is using the [handbook to store documentation], we should too. – @mikemueller
- WordPress TV’s is an example of a handbook that we all love: it is accessible, organized, etc. – @courtneyengle, @mikemueller, @meaganhanes
- We need to dig back into the archives and also consider what belongs in the handbook, and then think about where to store the pages that contain lesson plans. – @courtneyengle
Courtney Engle Robertson 5:37 pm on October 13, 2015
Recap of comments from 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/. team meeting October 12, 2015
- Our handbook is currently being used to store our lesson plans. This is confusing for those looking for our handbook.
- Pain point: the confusing nature of the “empty” lessons that have been started with just the template and are sitting there in the handbook
- Suggestion to make the lessons plans that are in-progress not public
- The web address https://make.wordpress.org/training/handbook/ says that it is a handbook, but in fact it’s the parent page for Lesson Plans. (@courtneyengle) It reads visually as a page error – I was waiting on something to load (@irishguy)
- No matter where we store Lesson Plans – that top page for them is awfully blank… like no book cover art. It’s just a jump to the table of contents. It’d be weird if that were a paper book
Courtney Engle Robertson 12:21 am on October 21, 2015

https://make.wordpress.org/training/2014/10/30/lesson-plans-moved-from-pages-to-handbook/ details why lessons landed in Handbook.

Welcome

Meetings (Calendar)

Share this: