Tag Archives: developer-documentation

Justin Ahinon 11:02 am on December 4, 2020
Tags: developer-documentation   

Gutenberg developer documentation – Meeting Notes December 2nd

Attendance: @paaljoachim, @collinsmbaka, @justinahinon.

Agenda: https://make.wordpress.org/docs/2020/11/30/gutenberg-developer-documentation-zoom-meeting-agenda/

Video recording: https://drive.google.com/file/d/1y4PUVjx28AfYH9d75zH_dAyNAt-XYmgo/view?usp=sharing

Summary

In short, we discussed the genesis of the project to restructure the 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. editor’s developer documentation. Then we went through the current structure of the documentation, the different issues that have already been opened and the site that @paaljoachim created to iterate our efforts.

We finally discussed the next steps for the project.

Next steps

Keeping track of all the documentation improvement work

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/ issues related to documentation improvement will be tracked on this project board on the GitHub 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/ repository. These issues will be labeled developer-docs so that they can be found easily.

Gathering information on how the documentation is generated

An indispensable thing to do too is to know and retrieve information on how, when and how often the documentation on the site is generated.

Improve the site “landing page”

The first page you come across when going to the block editor’s developer documentation site is “Project Overview”. As its name suggests, this page is supposed to give developers a general overview of the project, its main parts and allow them to quickly start developing for Gutenberg.

Some issues have already been created for this on the GitHub repository. You can give your feedbacks to them or create new ones if needed.

New structure (summary) for the documentation

This step is highly correlated with the previous one. The documentation should be structured in such a way that it is easily accessible and also has a certain logical order.

For this step, it is important to keep an eye on the different documentation use cases that were identified earlier.

#developer-documentation

Justin Ahinon 11:30 am on November 30, 2020
Tags: , developer-documentation   

Gutenberg developer documentation – Zoom meeting agenda

In a previous post, we shared a Doodle link to choose times to attend a Zoom meeting on 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/ developer documentation.

The selected date for the meeting is: 

Wednesday, December 02, 2020, 08:00 UTC

Zoom link: https://us04web.zoom.us/j/79656401480?pwd=cXZ1U2t2MjFYQUFrQ3EwMzRLYW93UT09

Topic: WordPress Documentation Team - Gutenberg Developer Documentation

Join Zoom meeting:
https://us04web.zoom.us/j/79656401480?pwd=cXZ1U2t2MjFYQUFrQ3EwMzRLYW93UT09

Meeting ID : 796 5640 1480
Passcode : 9xHGhA

If you want to participate in the meeting, please read the initial restructuring proposal and the follow up post if you need more context.

Agenda

  • Introduction to the Gutenberg developer documentation restructuring proposal
  • Review of the current structure of the documentation (@paaljoachim)
  • Review of documentation use cases
  • Discussion on adjustments to be made to the documentation and next steps to move the project forward
  • Open floor

If you have others items that you would like to be discussed at the meeting, please comment on them in this post.

#block-editor, #developer-documentation

Justin Ahinon 3:30 pm on November 26, 2020
Tags: , core-js, developer-documentation   

Gutenberg developer documentation – Doodle for a meeting

This post proposes a meeting to go through the current structure of the 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/ developer documentation and discuss its information architecture.

A few months ago, I made a proposal to restructure the Gutenberg developer documentation. With the #core-js team, we then worked to identify the use cases of this documentation.

But there are still some points in relation to this documentation and the proposal that need to be clarified. It would be interesting to discuss this in a video meeting with interested people.

Here is the a Doodle link to choose the slots that suit your schedule for next week to participate in the meeting: https://doodle.com/poll/f4zpukgkhit92vdi.

Please read the initial restructuring proposal and the follow up post if you need more context.

The detailed agenda for the meeting is coming soon.

#block-editor, #developer-documentation

Justin Ahinon 1:07 pm on November 12, 2020
Tags: , developer-documentation   

Follow up on Gutenberg developer documentation restructuring proposal

The proposal to restructure 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/’s developer documentation was discussed a few weeks ago during the weekly 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/. office hours (rollback to the discussion here, meeting notes here).

We agreed that it makes sense to clearly identify stakeholders and use cases of the documentation before any action is taken.

This information has been collected in this Google Docs document.

The main stakeholders identified are:

  • Site developers: people who create WordPress sites with custom themes and plugins.
  • Site builders: people who create sites with primarily a page builder, or a theme that includes a page builder.
  • Theme Authors: Developers of WordPress themes, hosted on the official theme directory or elsewhere.
  • 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 authors: WordPress plugin developers.
  • WordPress Core contributorsCore Contributors Core contributors are those who have worked on a release of WordPress, by creating the functions or finding and patching bugs. These contributions are done through Trac. https://core.trac.wordpress.org.: People who contribute to the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. of WordPress, to Gutenberg, etc…
  • Content creators: People who create content on WordPress sites.

For each of these stakeholders, the nature of the expectations are different. Theme developers or contributors to WordPress want to be able to alter the way the 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. editor works, its structure or presentation; while site builders and content creators expectations will be best met by the user documentation for the block editor.

Next Steps

The major use cases that emerge from all those in the document mentioned above are:

  • Update/alter the UIUI UI is an acronym for User Interface - the layout of the page the user interacts with. Think ‘how are they doing that’ and less about what they are doing. or the structure of the editor and its elements
  • Create blocks for the block editor
  • Create block patterns
  • Programmatically modify or trigger the functioning of the block editor and its elements

The next steps to move forward could be to propose a structure around these major use cases.

You can do this as a comment to this article. This will also be on the agenda for the next JavaScript office hours.

#block-editor, #developer-documentation