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