BP Docs-Chat Agenda February 14, 2024

Hi!

Our next documentation meeting will happen on February 14 at 19:00 UTC ( less than 12 hours from now!) in #BuddyPress. Here’s our agenda:

If you have specific/additional points you need to discuss, please share them in the comments area of this post.

BP Docs-Chat Summary February 7, 2024

BP Documentation tracker stats

If you missed January 10 docs chat, We decided to create a new GitHub repository: bp-documentation, to use issues as Documentation tasks and to regularly update a GitHub project to track our progress.

  • BP Codex contains 271 pages.
  • 127 pages were reviewed so far.
  • 40 « migrate » tasks were created.
  • 87 « ignore » tasks were created.
  • 144 BP Codex pages still need a review.

Reasons to ignore a BP Codex page:

  • Codex page content is deprecated/outdated.
  • Codex page content is a user generated guide containing code snippets.

@im4th thinks checking every code snippets is still accurate would take us too much time. The ignored content is not lost as it will remain into the BP Codex for history.

We think we’ll probably need to include an Advanced Users chapter to the User Handbook.

Contributing to docs is improving code!

@im4th has found bugs with our Site Health debug panel while working on documenting it. He’ll soon open a Trac ticket about it.

@emaralive found another one with Profile photos when the image file contains « -bpfull »or « -bpthumb » within its name.

@vapvarun suggested to create new documentation links closer to WP Admin sections using an information dashicon for instance, these links would direct the user to the specific anchor of the generated Markdown file view on GitHub.

And..

An help tab containing a link to the documentation page on each BP Admin screen

@emaralive started this discussion about it & @im4th thinks we should always have an help tab with a documentation link for any BP Admin screens we’re adding to the WP Dashboard.

Open floor

  • We’ve decided to move the docs chat to every other Wednesdays that are a week after dev-chats. We’re starting next week on February 14 at 19:00 UTC. We haven’t changed the hour when we meet as 19:00 UTC is already very late for @vapvarun (he can’t currently contribute to dev-chats as it’s happening at 3 AM his time: we’ll need to discuss about it with other members of the team).
  • Take turns leading the documentation meetings: @vapvarun will lead next one, @emaralive the one after, etc… @im4th thinks it can be interesting to do so as he might miss or do not stress enough some points others would have. Here are roughly tasks a leader should achieve:
    • Prepare the docs-chat agenda & publish it on this site.
    • Run the chat in #BuddyPress.
    • Write the chat summary on this site.

Next Docs-Chat

It will happen on February 14, 2024 at 19:00 UTC in #BuddyPress.

⏳♻️

#docs-chat, #documentation, #summary

BP Docs-Chat Agenda February 7, 2024

Hi!

Our next documentation meeting will happen on February 7 at 19:00 UTC (in less than 12 hours from now!) in #BuddyPress. Here’s our agenda:

If you have specific/additional points you need to discuss about, please share them into the comments area of this post.

👩🏻‍🏫👨‍🎓

#docs-chat, #documentation

BP Docs-Chat Summary January 24, 2024

PS: we were so captivated to learn from @JavierCasares (one of the WP Hosting Team reps & the Lead for the WordPress Advanced Administration Handbook) on using GitHub to contribute to an open source project’s documentation that we completely dedicated this chat on this subject.

Let’s learn from the Hosting and the Advanced Administration Handbooks

GitHub main benefits:

  • A place where documentation can be edited by “anyone”.
  • A place where we can track documentation tasks (or issues) & discuss out loud and visualize progress using Projects.
  • A way to standardize how to write documentation using the Markdown language.
  • A transparent contributing / publishing workflow.
  • Documentation’s repository content is regularly synchronized (every 15 mins) with a WordPress site thanks to the Handbook plugin.
  • A place where we can keep track about Documentation’s history.

NB: the manifest.json is the main controller for the synchronization task. As long as a documentation page is not referenced into it, it’s not synchronized.

Dealing with “Markdown’s fear”:

A concern we discussed a while back was about the fact Markdown / Github can limit contributions when it comes to writing User documentation: some people willing to contribute might consider “learning” Markdown or using GitHub a discouraging step. @JavierCasares told us the Spanish Community Handbook (es) is using the GitHub “bridge” and shared with us how they dealt with this:

Important things to keep in mind for BP Docs

  • Documentation is as important as code.
  • Try to keep the handbook structure easy: limit folders tree to 2 levels.
  • Having an Advanced user section might be needed.
  • Work on a best path to quickly start enjoying BuddyPress (“documentation wizard”).
  • Choosing the GitHub “bridge” way was the right move and we’ll be ready for a very interesting future about reading documentation in many languages (@JavierCasares told us about the GlotPress project about parsing Markdown to ease Documentation translations.

Next Docs-Chat

It will happen on February 7, 2024 at 19:00 UTC (that’s tomorrow, agenda will follow shortly!) in #BuddyPress.

📖 👩🏽‍🤝‍👨🏻

#docs-chat, #summary

BP Dev-Chat Agenda February 5, 2024

Hi!

Our next development meeting will happen on February 5 at 21:00 UTC in #BuddyPress. Here’s our agenda:

  • What do we expect from 14.0.0? Let’s wrap it. Some interesting ideas were shared into this topic.
  • First 14.0.0 schedule

If you have specific/additional points you need to discuss about, please share them into the comments area of this post.

🧺🗓️

#14-0-0, #agenda, #dev-chat

WordPress required version update

Hi!

Please note that BuddyPress 14.0.0 will require WordPress >= 6.1.

To learn more about this change: https://buddypress.trac.wordpress.org/ticket/9051

To learn more about how we decide to bump our WordPress required version: please read this documentation resource.

#14-0-0, #wp-requirements

BP Dev-Chat Summary January 22, 2024

Minor releases

  • Shortly after 12.1.1 release, a bug was reported in Forums about the fact 12.0 deprecated functions were not loaded when BuddyPress was first installed with 12.1.1. @im4th & @emaralive worked on #9075 and fixed the issue. Decision was taken to release 12.2.0 a day after the chat. This new minor version contains some other regression fixes.
  • BP Classic also required a minor version. 1.3.0 was released two days after the chat.

Next major version is 14.0.0

  • After a discussion about our release packaging process which is mainly a « manual » one, @espellcaste suggested to build a GH Action to save us some time & energy, see #9080.
  • @im4th reminded us we can share our ideas about 14.0.0 from this support topic.
  • @espellcaste also volunteered to review the BP PHP Unit Tests tool to make it easier for BP plugin developers to use it. He found out installing BuddyPress into this context wasn’t optimal when working on 2 external plugins. See #9081. He reminded us he shared his ideas about 14.0.0 in a reply to January 8 dev-chat agenda.
  • @im4th informed he should update WordPress env npm package to 9.0.0 soon. This change should ease the GH Action about PHP unit tests. See #9053.
  • Talking about the ticket to bring BP 12.0 support to bbPress, @dcavins reminded us about @boone’s polyfill which can help plugin developers to move forward & stay back compatible with BuddyPress « Classic » versions (11.4.0 & lower). It’s available on Packagist.
  • @im4th thinks it’s great news @espellcaste plan to work on improving the BP REST API as it will be used a lot into the BuddyVibes BP Block Theme.
  • @emaralive asked about a tentative target date for the 14.0.0 release & we agreed to give us 2 more weeks to think about it. As @espellcaste wasn’t aware about our decision to skip the bad number 13, we reminded him this decision came from @im4th’s fear about this number 🐈‍⬛🪜.
  • We finally talked about the will we shared on feedback posts to progressively shrink BuddyPress transforming optional components into separate BP add-ons. The Blogs component will probably be the first to be transformed this way. The fact 12.0 was a huge first step towards a Modern BuddyPress is probably explaining why @im4th is not thinking about it as an emergency. @emaralive rightly said working on BP Documentation has a higher priority.

Next Dev-Chat

It will happen on February 5, 2024 at 21:00 UTC in #BuddyPress.

🍀🐰

#12-0-0, #14-0-0, #dev-chat, #summary

BP Classic 1.3.0 is available

1.3.0 is a maintenance release, please update.

☝️🧐

#1-3-0, #classic, #maintenance, #release

BuddyPress 12.2.0 is available

12.2.0 is a maintenance release, more info about it here:

Please update to 12.2.0 🙏

#12-2-0, #9075, #maintenance, #release

BP Docs-Chat Agenda January 24, 2024

Hi!

Our next documentation meeting will happen on January 24 at 21:00 UTC in #BuddyPress. Here’s our agenda:

  • Using GitHub to auto-publish in WP Sites with @JavierCasares
  • BP Documentation tracker status.
  • What about putting « shared » doc resources (eg: changelog, official graphics,…) directly into the `buddypress/docs` sub folder?

Please note we are exceptionally scheduling this meeting 2 hours later than usual: at 2100 UTC.

If you have specific/additional points you need to discuss about, please share them into the comments area of this post.

💡🔮

#agenda, #docs-chat, #documentation