Author Archives: Drew Jaynes

Drew Jaynes 4:02 pm on July 14, 2016
Tags: , , ,   

Docs Chat Agenda – July 14, 2016

Here’s the agenda for the Docs team weekly chat, which are held Thursdays at 17:00 UTC in the #docs channel on 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/..

Current Projects Updates:

  1. Theme Developer Handbook – @kenshino
  2. Codex MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. (DevHub) – @drewapicture
  3. DevHub – @drewapicture
  4. HelpHub – @kenshino
  5. Inline Docs – @drewapicture

Other Stuff:

  1. Internationalizing documentation
  2. Version articles (HelpHub)
  3. Hosted about pages
  4. Open Floor

#chat, #codex-migration, #handbooks, #helphub

Drew Jaynes 12:15 pm on June 23, 2016
Tags: , examples   

Codex Migration project update

History

When the docs team embarked on the Codex Migration project at the 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/. in June 2015, it seemed like a daunting, never-ending task.

The goal was simple: move away from using the Codex as the canonical reference for developer docs to a newly-established “Developer Hub”. The bulk of the documentation would be parsed from the WordPress source and be supplemented with some manually curated documentation along with user-contributed notes (examples).

There were a lot of reasons for why the Codex migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. project was launched, the most prominent being that the Codex had reach an un-maintainable state as a manually curated community reference. Now a year later, we’re well on our way toward completely migrating all function references from the Codex to the Code Reference.

Side note: The HelpHub project also falls under “Codex Migration”, but more on the user and support docs end of the spectrum. Check out the HelpHub project page for information on contributing that effort.

Examples Migration

It all started with the examples.

Over the last year, 15 or so contributors manually migrated more than 1,100 function examples to the Code Reference and submitted them to the moderation queue as user-contributed notes.

Before approval, each example was individually evaluated for accuracy, completeness, and security by about 10 trusted reviewers from throughout the community. I approved the last of the migrated examples just a few weeks ago.

Content Migration and Redirection

With mixed feedback from the community, we’ve started the long process of redirecting the more than 1,200 function references from the Codex. Like the examples, each redirection is happening manually; there’s no automation here.

Great care is being taken to ensure that any useful (and accurate) information in the Codex makes the move too, either through direct improvements to the inline docs or by being brought over to the “More Information” section of each reference page.

Side note: we’re already seeing some of the “More Information” sections getting to be pretty long in some cases, and are looking into implementing some in-page navigation to make discovery a little easier.

Thank You Contributors

At this point, I’d like to send out thanks go to all of our contributors so far: @adamsilverstein, @atachibana, @bford2here, @bhlarsen, @boogawooga, @cmmarslender, @DBrumbaugh10Up, @hearvox, @helen, @ishulev, @marcomartins, @mcadwell, @morganestes, @mrsipstenu, @ninnypants, @rabmalin, @stevegrunwell, @sudar, @theMikeD, @tott, @vlastuin, @webdevmattcrom, @znowebdev

Special thanks also go of course to @samuelsidler and @siobhan for their steadfast support in getting this project off the ground in the first place, and to @coffee2code for managing the bulk of the infrastructure, special requests, and development of features in getting us this far.

We Need Your Help

According to the progress graph, approximately 160 function references have already been migrated and redirected. There are another ~900 still to be moved. If we follow a strict regimen of migrating at least 10 references a day for the next 3 months we should be able to complete the function reference section of the Codex Migration project. Of course that still leaves class and hook references, but one thing at a time 😅

It’s doable, but I probably shouldn’t try to do it all myself without a little bit of help. If you’re reading this and thinking, “Boy, I think I can help with this,” pipe up in the comments below or pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” me on 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/. at @drew in the #docs channel.

We’re over the hump, but there’s a long way to go. More frequent status updates will follow.

#codex-migration, #examples

Drew Jaynes 7:31 am on June 23, 2016  

Re-re-starting weekly Docs chats

Yep, we’re really doing it this time! Starting Thursday, June 30, 2016 17:00 UTC, we’ll be restarting weekly Docs chats.

The docs team has kind of floundered for a long time now in terms of not having weekly chats and generally failing to onboard new docs contributors. Let’s get this thing going again.

After speaking with @kenshino (who has awesomely taken on stewardship of the HelpHub and Theme Developer Handbook projects), I’ve adjusted the weekly meeting times back an hour to 17:00 UTC.

As usual we’ll be meeting in the #docs channel on 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/..

Check out the Weekly Meetings list in the sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme. for more information on the various docs-related chats happening on a weekly basis.

Drew Jaynes 5:18 pm on October 15, 2015
Tags:   

Docs Chat Agenda, Oct. 15, 2015

Here’s the agenda for today’s Doc Chat in the #docs channel on Slack.

Time/Date: October 15 2015 18:00 UTC:

  1. 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/. Docs – We’ve had multiple requests for documentation on actionable steps for contributor days. Let’s make a plan.
  2. Project Updates
    1. Theme Developer Handbook – @thoronas
    2. HelpHub – @hlashbrooke
    3. Codex MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. – @drewapicture
    4. Inline Docs – @drewapicture
  3. Open Floor – Have something you’re looking for feedback? Bring it up and let’s chat about it.

#agenda

Drew Jaynes 7:03 pm on October 1, 2015
Tags:   

Docs Chat Recap, Oct. 1, 2015

Here’s a recap of the Oct. 1, 2015 Docs Chat:

Attendees: @nlarnold1, @lizkaraffa, @justingreerbbi, @justinsainton, @liamhogan, @slaffik, @samuelsidler, @drewapicture

Chat Archive (must be logged-in to Slack to read, sorry): https://wordpress.slack.com/archives/docs/p1443722420000955

  1. Project Updates
    1. Theme Developer Handbook – @lizkaraffa
      • @iwritten and @thoronos have been working on some good things the past week or so. @lizkaraffa will be going on maternity leave soon and feels that the “ship” can likely steer itself in her absence. Sounds like @thoronas might be a good point of contact as he knows most of what’s going on with the handbook currently.
    2. HelpHub – @hlashbrooke
      • @hlashbrooke wasn’t able to make it to the meeting, but he posted his update as a comment on the agenda post.
    3. Codex MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. – @drewapicture
      • The Codex Migration project is cruising along. I cleared out the moderation queue for examples the other week and will likely start redirecting more Codex pages in earnest this week based on our progress and readiness.
    4. Inline Docs – @drewapicture
      • I recently hit 1,000 commits for coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress., very possibly about 950 of those were for inline documentation, so yay for continuing to improve the quality of our inline documentation.
  2. “Weekly” Chats
    • We discussed continuing forward with meeting every other week, and doing weekly office hours during the normal chat time in the off weeks. This will allow new contributors to more easily get involved if they know we’ll be meeting/available at a consistent time.
  3. Open Floor
    • @slaffik raised a question about adjusting some now-defunct links for IDE packages on the inline docs standards, @drewapicture will take care of it.
    • @drewapicture is continuing work to improve particularly neglected areas of the core contributor handbook, including the “Automated Testing” article for unit testing.
    • A new contributor asked about how to get involved with contributing to the Codex Migration project, and links/information were shared.

#recap

Drew Jaynes 3:39 pm on October 1, 2015
Tags:   

Docs Chat Agenda, Oct. 1, 2015

Here’s the agenda for today’s Doc Chat in the #docs channel on Slack.

Time/Date: October 1 2015 18:00 UTC:

  1. Project Updates
    1. Theme Developer Handbook – @lizkaraffa, @topher1kenobe
    2. HelpHub – @hlashbrooke
    3. Codex MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. – @drewapicture
    4. Inline Docs – @drewapicture
  2. “Weekly” Chats – Should we alternate docs chat with office hours every other week? Right now we’re seemingly only meeting once every two weeks.
  3. Open Floor – Are there any outstanding docs projects we should be tracking? Any areas where we should be looking to focus energy? Bring them up and let’s talk about them.

#agenda

Drew Jaynes 3:52 pm on September 17, 2015
Tags:   

Docs Chat Agenda, Sept. 17, 2015

Hey everybody. Sorry to cut our docs chat inertia short last week. I’ve been out of the country and the timezone differences are presenting an interesting challenge. In fact, I won’t be available to run the docs chat today, so I’m hoping maybe Sam can run it, or perhaps a leader might emerge and rise to the occasion today!

Here’s the agenda for today’s Doc Chat in the #docs channel on Slack.

Time/Date: September 17 2015 18:00 UTC:

  1. Project Updates
    1. Theme Developer Handbook – @lizkaraffa, @topher1kenobe
    2. HelpHub – @hlashbrooke
    3. Codex MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. – @drewapicture
    4. Inline Docs – @drewapicture
  2. Open Floor – Are there any outstanding docs projects we should be tracking? Any areas where we should be looking to focus energy? Bring them up and let’s talk about them.

I’ll go ahead and give an update on the Codex Migration and Inline Docs here, since it’s pretty likely I won’t be able to make it to today’s chat:

Codex Migration

Work is continuing on reviewing submitted examples on the spreadsheet and moving other useful content from Codex references to the Code Reference explanations. If you’re interested in getting involved as a contributor, there is an article in the docs handbook that can help you get started. If you’re interested in getting involved a reviewer (for migrated examples), pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” me (@drew) or Sam (@samuelsidler) in the #docs channel on 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/..

Inline Docs

Current initiatives in progress include:

  • Standardizing coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. file headers, #33701, this is especially necessary due to all of the new files being created in the reorganization happening in #33413
  • Add missing documentation for the $default parameter for get_query_var() in #33856
  • Better documenting the optional parameters for add_query_arg() in #33912
  • Yesterday, I added better documentation for the optional “phantom” arguments for current_user_can() and related functions in #32694
  • Continuing to clean up poorly-formatted docs in all places in core (generally) in #32246

#agenda

Drew Jaynes 3:29 pm on September 3, 2015
Tags:   

Docs Chat Agenda, Sept. 3, 2015

Here’s the agenda for today’s Doc Chat in the #docs channel on Slack.

Time/Date: September 3 2015 18:00 UTC:

  1. Roll Call – Who’s working on what? It’s been so long since we’ve met, we should probably find out who is working on what. There are bound to be some new faces and probably some missing old ones.
  2. Project Updates
    1. Theme Developer Handbook – @lizkaraffa, @topher1kenobe
    2. HelpHub – @hlashbrooke
    3. WordPress CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. Weekly crossover – @morganestes, @swissspidy
    4. Codex MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. – @drewapicture
    5. Inline Docs – @drewapicture
  3. Open Floor – Are there any outstanding docs projects we should be tracking? Any areas where we should be looking to focus energy? Bring them up and let’s talk about them.

#agenda

Drew Jaynes 11:40 pm on August 30, 2015
Tags:   

Restarting Weekly Docs Chats

Hey y’all,

It’s been awhile since we had weekly docs chats, and I think it’s about time to start them up again.

In making the decision to skip the weekly chats and move to monthly chats, then later to skip all chats altogether, I think we managed to completely unwind all of the organization around docs team initiatives and projects. Not good.

We need to reverse the reversal!

Re-starting Weekly Chats – Sept. 3

Per the time and date in the sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme. here on make/docs, we’ll be restarting weekly chats at Thursday 18:00 UTC 2015 in the #docs channel on Slack.

In a couple of days, I’ll post an agenda for Thursday’s meeting. The gist will be that this week, I’d like to talk about status reports on the Theme Developer handbook, HelpHub, and other projects. Mark your calendars and join us!

#meetings

Drew Jaynes 10:04 pm on December 16, 2014
Tags: , , ,   

@kpdesign has been working day and night to…

@kpdesign has been working day and night to get the 4.1 version article filled up leading up to this week’s release. She could really use some help getting it into shape.

In particular, the Under the Hood section could use a bit of work by folks who have more intimate knowledge of coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.. These would be people like @ipstenu, @sewmyheadon, @dh-shredder, @boonebgorges and others who have helped out in the past.

If you think you know someone from the core team who could lend a hand, please please point them this way.

Some items may also need to simply be reorganized from section to section. Any and all help would be greatly appreciated.

We’re primarily working off of two checklists:

Anything checked off has already been added to the version page in some form, or skipped for brevity.

#codex, #core, #release, #sprint