WCSF 2014 Docs Contrib Day Notes

Purpose to see how we are doing on Docs and look towards the future

PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party handbook

  • Almost complete. One page left to write
  • Siobhan is holding back launch with the intro 😉
  • Landing page on developer.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/ will be updated to unveil the plugin hb tomorrow!
  • How can we get feedback from the users on handbook pages?
  • Add list of pages from the codex that can be redirected or need content migrated into the spreadsheet

Theme handbook

  • At 67% completion
  • Future focus can be put completely on theme hb instead of splitting with plugins

Contributor days

  • Difficult to retain contributors
  • Takes a while to get them up to speed on how to contribute
  • Are still useful as contributors that do return contribute significantly

Developer.wordpress.org

  • Landing page will show the new theme
  • Theme hb link should be whited out and say coming soon
  • Need examples contributed to the code reference
  • Need a way to group together items in the functions reference. Possibly a tag that can be added. Scott (coffee2code) is looking into options
  • The 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. APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. docs need to be pulled in. Currently exist as markdown on 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/
  • Need a banner on the handbooks that lets users know all content is volunteer contributed and they can get involved

Future

  • Go through codex and find pages that can be relevant to the plugin handbook
  • Siobhan will provide list of high traffic codex pages that need to be checked for content and redirected to plugin handbook
  • Need list of content that is duplicated between both plugin and theme handbook (E.G javascriptJavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. https://www.javascript.com/.)
  • Where should content live that does not exactly live in either handbook? (E.G list of javascript libraries built into WordPress)
  • Need a 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/. bot that will send messages to #docs when user wants to ask a question???
  • How do we easily let in new users to edit handbooks? This needs more discussion. Prefer to contact a human to get access. Preferably one of the editors
  • Will be implementing an issue tracking system that will contain tickets for things that need updated/added

Make.wordpress.org/docs

  • Instead of weekly meetings we should use the blog to post questions, get feedback, etc
  • Switch to monthly all docs team chats

#handbooks, #wcsf2014

This weekend @sewmyheadon is hosting a Documentation Sprint…

This weekend @sewmyheadon is hosting a Documentation Sprint in Seattle. If you are in the area and would like to join in person join us at Uptown Espresso on Westlake. If you are remote please join us in #wordpress-sfd on Freenode.

For full details see the Meetup post at http://www.meetup.com/SeattleWordPressMeetup/events/196326602/

#handbooks, #plugin, #sprint, #theme

Weekly Handbook updates I ran the handbook chat…

Weekly Handbook updates

I ran the handbook chat for @samuelsidler yesterday while he was out. Present were @blobaugh @jerrysarcastic @topher1kenobe @sewmyheadon

The theme handbook is coming along. This weekend is another of the monthly doc sprints and @sewmyheadon is hoping to knock out a good chunk of the handbook.

A couple more sections of the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party handbook have been marked 100% or are ready for review. Thanks again to @topher1kenobe for doing much of the heavy lifting!

MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. to the new devhub has been going slowly but has had some progress.

In addition to the monthly doc sprint in Seattle hosted by @sewmyheadon there will also be a general 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 Tacoma starting soon. Also led by @sewmyheadon. What a great guy!

The handbooks are still a work in progress and we are always happy to have more contributor, either writing content, editing, proofing, testing, or other! If you would like to help out please contact @samuelsidler @blobaugh or @sewmyheadon

#handbooks

Handbooks Update May 28 2014 Our weekly chat…

Handbooks Update: May 28, 2014

Our weekly chat in #wordpress-sfd on IRC at 2:00 PM PST happened today with @blobaugh @sewmyheadon @topher1kenobe in attendance.

@blobaugh ran the meeting while @samuelsidler was out.

IRC log available https://irclogs.wordpress.org/chanlog.php?channel=wordpress-sfd&day=2014-05-28&sort=asc#m114132

Theme Handbook
Due to the U.S. holiday this week not much got done
Instead of a scattergun approach an intentional section by section approach is being taken that has helped progress
New contributors have contacted @sewmyheadon (Eric) about helping with the theme HB!
Interested in helping? Email eric@ivycat.com or comment here.

PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party Handbook
Due to the U.S. holiday this week not much got done
Following @sewmyheadon sectional approach, @topher1kenobe and @blobaugh have a Google Hangout triage meeting setup for Thursday May 29, 2014 at 7:30 AM PST. If you would like to join watch the #wordpress-sfd room for the link.
New contributors have contacted @blobaugh about the plugin HB
Interested in helping? Email ben@lobaugh.net or comment here.

@sewmyheadon is hosting an in-person/virtual Doc Sprint on June 7, 2014. http://www.meetup.com/SeattleWordPressMeetup/events/175531242/ Everyone is welcome to join. If you want to participate virtually join the #wordpress-sfd IRC channel.

#chat-recap, #handbooks, #plugin, #theme

Handbooks Weekly Chat update @samuelsidler was out today…

Handbooks Weekly Chat update

@samuelsidler was out today so I lead the discussion. @sewmyheadon was also unable to attend so chat centered around the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party handbook.

  • Shortcodes section is almost complete (Thanks @topher1kenobe!)
  • We need someone who knows how TinyMCE renders shortcodes in the editor to round out the section
  • The plugin spreadsheet is being updated on an on going basis
  • Some relevant content from the Codex is being moved into the handbook (E.G. CPTs)
  • Instead of randomly attacking the list we are more purposefully moving section by section.

We still need more volunteer writers! If you want to get involved drop me a line at ben@lobaugh.net 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 IRC.

Honorable mention was @jerrysarcastic sarcasm 😉

#handbook-chat, #handbooks