Developer Blog Editorial Group – Meeting Notes September 1, 2022

Attendees: @marybaum, @daisyo, @milana_cap, @psykro, @webcommsat, @mburridge, @bcworkz, and @bph

Agenda

  • Introductions
  • Editorial Guidelines (from this proposal)
  • Infrastructure of the Developer Blogblog (versus network, site) 
  • Project / Issues tracking
  • Review process
  • Tasks & Posts left to go live

Editorial Guidelines for Writers and Reviewers

From the proposal: 

From the discussion, the consensus emerged that this new Developer blog is not just ‘more documentation’. Rather, it’s a place to talk to developers as people, first, and then as members of a community.

To that end, the group agreed that one of the first pages on the blog should be about writing for the blog—both in tone, from the above style guides, and with tips and tricks on how to write, so people will keep reading. 

These examples might go on such a page (and drive its tone): 

  • In an open-source environment, there is no imperial we’re making the decisions and doing the things. Specific people, or groups of people, might do things, and the code does things. Spell out who is driving the action.
  • Use active verbs; the way to get around using we is not to say a thing was done (by magic?), but to say that a person, group, function, or other piece of code does a thing. In a pinch, say a thing happened or got done; at least getting done is a little more active than being done.
  • Make the reader the star of the show. Walk in their shoes, and lead the way forward, to show what they’ll get from reading the next sentence, and the next, until they see the tangible benefits that come when they do what you recommend. 
  • Look to the Documentation Style Guide for official terminology re: code examples, references to UIUI User interface elements and technical instructions, so they stay consistent across the teams. 

The training and marketing teams have published guidelines that can be screened to ensure consistency across the project.

For using screenshots within a post, this Best Practices for Capturing Screenshots will be a useful guide. Other assets like video, animated GIFs or presentation would need to covered as well.

The blog will also need a set of publishing standards to guide decisions on SEO, excerptExcerpt An excerpt is the description of the blog post or page that will by default show on the blog archive page, in search results (SERPs), and on social media. With an SEO plugin, the excerpt may also be in that plugin’s metabox. handling, subheaders, featured images, TL;DRs etc. 

As the group builds the GoLive edition, it will have to handle these things for the first time; later iterations can influence long-term policy.

Authorship 

The proposal said: “Posts should be published by users of 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/, with the author link going to the WP Profile page. Authors should also credit reviewers, editors, and other contributors.” 

Participants agreed to clarify that the author link should go to a contributor’s personal WP.org profile and not a company’s profile. That follows how the training team handles authorship. 

Original content and republishing  

Participants discussed concerns of plagiarism and how to detect it. It was suggested during a still to be finalized submission process, the author will give assurance that its original content. Another suggestion is to include this topic in a future reviewer’s checklist, but to avoid it becoming a difficult task with the onus being on checking the author had self-verified it as original content. In the longer-term future, blockchain technology may be able to assist. 

Infrastructure for the Developer Blog

  • The Developer Blog site is on the way to have final design and information architecture for GoLive. It is only accessible to the contributors working on it. 
  • Asynchronous discussions and announcements take place in the new WP 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/. channel #core-dev-blog
  • The public 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/ space Developer Blog Content tracks content tasks, which already has an initial set of labels and stages. That set is bound to grow as the team adds content categories and issue types. A separate Discussion space can host ideas for blog posts, relevant conversations and even final outlines before a given idea becomes an actual task on the issue list. 
  • This project board will show content as it progresses from concept to published posts
  • The Theme’s code also lives on GitHub. 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 owns it, just as it does the rest of WP.org. 

Birgit will add editorial group members to the site and GitHub spaces in the following weeks and message them on WP Slack. 

The Review process is roughly as outlined in the proposal.  With the GitHub tools it can come to life. 

Once the first set of posts go through the process, the editorial group will likely have tweaks to make to the formal guidelines. 

Task list to Go live 

  • A great set of first posts. 
    • Three ideas
      • Business case for create-blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. script adoption
      • Perspective Change between classic themes + Block Themes
      • Journey of a PHPPHP The web scripting language in which WordPress is primarily architected. WordPress requires PHP 5.6.20 or higher developer to GutenbergGutenberg The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/ adoption, enhancing Core blocks and building custom blocks.
    • Meeting leaders asked participants to think about additional ideas, and also mention it to other contributors and members of the community, on what is particularly missing.  
  • Review collected posts by the editorial group
  • Draft more content areas for the following blog pages, and share with the group to help start building:
    • About page
    • How to get involved
    • Editorial Guidelines
  • Finish setting up the website 

Tasks will go on the issues list for collaboration and version controlversion control A version control system keeps track of the source code and revisions to the source code. WordPress uses Subversion (SVN) for version control, with Git mirrors for most repositories.

Future meetings

The next meeting will be October 6, 2022, at 13:00 UTC / 9 am EDT 

Initially, meetings will be once a month on the 1st Thursday of the month. 

  • November 3rd at 13:00 UTC / 9 am EDT
  • December 1st at 13:00 UTC / 9 am EDT

Props for review: @webcommsat @mburridge @jeffpaul 

#core-dev-blog

Proposed Editorial Process for the new Developer Blog

The early months of this year saw a published proposal to create a Developer Blog on developers.wordpress.org. The blogblog (versus network, site) is still an overall project goal for 2022

The next steps are  to firm up some editorial guidelines and introduce the group of people who are, so far, stewarding  the initiative. 

This post takes both of those steps and offers a list of content suggestions. None of this is set in stone: you will have questions, ideas, and other suggestions as you read through what is below. Those thoughts of yours are vital – please share them in the comments. 

The name of the new site is ‘Developer Blog’. Originally, it was going to be called the “Developer News Blog”, until some contributors realized that some of their best content ideas were not strictly news. So, why limit the scope? News can be incorporated as well as having wider information and updates.

The #meta team is almost finished, setting up the new blog site; thank you to @ryelle for her hard work adapting a News theme for this. 

The stewards of the original blog proposal have started recruiting people from WordPress contributor teams to build an editorial process and publishing guidelines. 

The process will likely include these tasks: 

  • identify gaps in developer knowledge, 
  • suggest topics, 
  • find writers, 
  • peer review of the posts, and
  • report back to their teams on current updates. 

A huge Thank You to the contributors, who agreed to be available for the Developer Blog Editorial group:

  • Jonathan Bossenger (Training) @psykro
  • Mary Baum (CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.) @marybaum
  • Michael Burridge (Documentation) @mburridge
  • Milana Cap (Documentation) @milana_cap
  • Francesca Marano (Test/Polyglots) @francina
  • Anne McCarthy (Test) @annezazu
  • Glenn Messersmith (Support) @bcworkz
  • Joe Simpson (AccessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility)) @joesimpsonjr
  • Justin Tadlock (Documentation) @greenshady
  • Abha Thakor (Marketing/Core/Training) @webcommsat

During the initial phase, I’ve offered to facilitate the first few meetings, some day-to-day adminadmin (and super admin) and outreach to authors and reviewers. We need a volunteer to help lead this group and initiative. If you are interested, reach out to me via direct message in the WordPress 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/. or leave a note in the comments below. At this stage, it is hard to estimate how much time this would take, as processes are still to be set up.

Editorial Meeting Frequency and Agenda Suggestions

  • Once a month in #core-dev-blog channel 
  • Round Robin and discussions: Topics/Questions/Ideas from the team meetings, in support forums, questions that came up in Social Learning events, StackOverflow/ StackExchange, Twitter and other related communities. 
  • Divide up a list of received blog posts for peer review (also async possible between meetings).
  • Discuss comments and suggestions from readers.
  • Open Floor.

Once the meeting frequency is finalized, it will be added to the make.wordpress.org/meetings calendar.

Suggested Editorial Guidelines 

Authors on the Developer Blog should follow the Make/Core Post & Comment Guidelines regarding Peer Review and Style and Substance. They also should follow the WordPress Documentation Style Guide 

Authorship

Posts should be published by users of 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/, with the author link going to the WP Profile page. Authors should also credit reviewers, editors, and other contributors. 

License

The license for content and media could follow the WordPress Documentation license 

 CC0 1.0 Universal (CC0 1.0) Public Domain Dedication

Original content and republishing  

On the Developer blog, only original content will be posted so that we don’t need to get additional written permission for republishing on the Developer Blog and so the proper creative commons license (cc01) is attached. 

If an author wishes to republish a post on a different site, it will be requested that the canonical URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org points back to the Developer Blog, but due to the licensing as CC0.1 it will not be monitored. 

Administration

  • Create a public channel on WP Slack #core-dev-blog 
  • Use a 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 for content pipeline (assign to contributors and track the state of production. etc.) 
  • Liaise with authors, editors, and reviewers

Content Suggestions 

The Developer Blog doesn’t replace any of the available team blogs or documentation handbooks. The primary target audience will be developers who write plugins, themes, or work for agencies, and use code to solve problems. 

What kind of blog posts are aimed for this site?

The list is certainly not comprehensive or exclusive. It should trigger a few additional ideas.

  • Updates of GutenbergGutenberg The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/ 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 releases pointing out changes relevant for developers. This could be updates to the create-blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. scripts, a new 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., or new extensibility opportunities. The corresponding Make Blog highlights End User features and UIUI User interface changes.
  • A monthly list of updates to the Gutenberg documentation and other components, to allow developers to catch up on this month’s changes.
  • Primers of advanced programming concepts used on Gutenberg and around Core. i.e., functional programming, state management. What is a reducer, resolver, arrow functions,  etc. 
  • Developer Case Studies: 
    • On implementing certain features into plugins or themes. 
    • On challenges and how to overcome them. 
  • PHPPHP The web scripting language in which WordPress is primarily architected. WordPress requires PHP 5.6.20 or higher gems – rarely used core functions/hooksHooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same. with usage examples.

How can people contribute? 

After the site goes live, if you want to write a post for the WordPress Developer Blog: 

  • Pitch your post with Title and two summary paragraphs (for first time contributors: use Google Docs, existing authors: add a draft post to the site.)   
  • Share link in the public channel #core-dev-blog,
  • It will be discussed in the next meeting. 

Until the site is live, you can share your pitch with the title and two summary paragraphs through a comment on this post. 

How to participate in the editorial group

That’s an open question, the editorial group could discuss this in one of its first meetings. If you would like to join in on the work, please indicate in a comment on this post. 

Please comment on this proposal by July 20, 2022.

Props😍 to collaborators and reviewers: @cbringmann, @marybaum, @annezazu, @chanthaboune, @greenshady, @webcommsat, @mburridge, @milana_cap and @angelasjin.

#core-dev-blog

#developer-news

Proposal to Start a News blog on developer.WordPress.org

Staying on top of the new features coming to the WordPress open-source project is one of the main barriers expressed by developers.

The Make CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. blogblog (versus network, site) has a heavy emphasis on meeting notes for the various core teams, rather than highlighting new features. This makes it difficult for developers who are not contributors or who just occasionally contribute to find the relevant information among the team-related posts. 

To achieve one of the big-picture goals for 2022 (“Create a developer-focused communications site“), this is a proposal for creating a Developer News blog. The content focuses on updates for developers, extenders creating plugins and themes, and those who work with WordPress at an agency or as freelancers. 

Preliminary Timeline

  • Proposal and request for comment period: February 25 – March 18, 2022
  • Coordinate with Design and 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. Teams for theme (the News theme would be spectacular) 
  • Brainstorm meeting with team representatives: End of March
  • Content creation and first post: early April 2022 
  • Start-up phase: Through mid-July
  • Review and expansion to regular topics for developers: Fall 2022

Problem to be Solved 

The current developer.wordpress.org holds a ton of comprehensive documentation with examples, tutorials, getting started guides, and more. That being said, there are various improvements that could be made to make the site much more impactful. Some of these areas for improvement are outlined below. 

What’s missing: 

  • There is no changelog to signal various changes including when pages are updated or when new APIs appear or existing ones are augmented with new filters, hooksHooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same., and configuration. 
  • There is no mechanism to subscribe to updates. A blog would provide this feature. 
  • Outside #core-editor meetings and 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/, there is no single place to keep up with  ongoing discussions. For example, to learn about the new styling engine, a developer needs to visit three sites: Discussion, Tracking Issues, and the first PR.

Start-Up Phase

As a first step, the Developer News can tackle the above pain points by:

  • Surfacing updates to documentation, 
  • Highlighting new tutorials, and, 
  • Providing a way for developers to subscribe to stay up to date 

The Developer News blog can also be added to the Planet WordPress feed, so post titles also appear in the WordPress News WidgetWidget A WordPress Widget is a small block that performs a specific function. You can add these widgets in sidebars also known as widget-ready areas on your web page. WordPress widgets were originally created to provide a simple and easy-to-use way of giving design and structure control of the WordPress theme to the user. in the WP Adminadmin (and super admin) Dashboard. 

This initiative requires cross-team collaboration among contributors from the Documentation, Core (core-css, core-js, core-editor etc.), Training, and Support teams. 

These teams could use an existing WP 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/. channel for synchronous meetings, such as #docs or #core. During the meeting, team reps and other contributors can make editorial suggestions for topics and links that could be included in the next edition of an update post.

An editorial calendar can be an early agenda item for the meetings. 

After the initial start-up phase, the blog would be extended to regular topical posts relevant to developers. 

Possible Ideas for Future Expansion

  • Summaries from GitHub Discussions 
  • Excerpts from meeting discussions for distribution to a wider audience of developers
  • A post consisting of a summary of multiple dev updates 
  • Useful questions/solutions found on StackOverflow/StackExchange 
  • Reviews of existing documentation to identify gaps 

A possible future expansion would include a regular revision process to update content with new information and changelog recording. 

I recommend that contributors to this initiative comply with the Make Core Post and Comment Guidelines. Should the editorial group decide to also include highlights of example plugins or themes, all products must adhere to the Community Team’s guidelines regarding GPLGPL GNU General Public License. Also see copyright license. compliance of the products, including premium products. 

As mentioned above, these are just some initial steps to get processes and contributors in place. Reader comments and discussion in the Slack channel will surface opportunities for further enhancements. 

What do you think? How could this proposal be improved?
Please share  your comments, your thoughts, and content ideas. If you’d like to contribute to the Developer News, mention this also in the comments. The comment period on this proposal will end on March 18, 2022. 

Props to Dion Hulse (@dd32), Destiny Fox Kanno (@piyopiyofox), Tara King (@sparklinerobots), Anne McCarthy (@annezazu), Tonya Mork (@hellofromtonya), Daisy Olsen (@daisyo), Dan Soschin (@dansoschin), and Anjana Vasan (@anjanavasan) for fruitful collaborating on this proposal. 
Props to Mary Baum (@marybaum) and Jean-Baptist Audras (@audrasjb) for final review

#core-dev-blog, #developer-news, #proposal