Tag Archives: documentation

Unknown's avatar emaralive 6:21 pm on August 4, 2025
Tags: , documentation,   

BP Docs-Chat Summary July 23, 2025

To Note: async (asynchronous) is a situation when an individual is not present during the meeting but, made an effort to make their presence known after the adjournment of the meeting. Additionally, user handles are taken from their respective Slack accounts and may not match up to WordPress.com accounts.

Summary: There was very little to report due to @emaralive was still ramping up on the learning curve for the Docusauras tool. Additionally, @emaralive was the only one in real-time attendance.

1️⃣ BP Documentation tracker status:

The stats – 58%, there was no change in percentage points – 58% ➡ 58%

NOTE: The stats remained flat due to no new issues were submitted and completions remained the same..

There is 1 (one) issue that is currently In Progress. For details see the In Progress section (Note: Project views are dynamic and are subject to change without notice).

Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 11:

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

General discussion – 2nd feasibility study – Docusaurus – example of use: WordPress Playground

@emaralive reported that he was still digesting the documentation provided by the tool maker (Docusaurus).

Phase 2 feasibility studies status

  • In progress:
  • To Do:
  • Completed:
    • Woocommerce REST API documentation, based on Slate – proposed here. – awaiting final report (star to be appended when final report has been published)

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

To provide context to this ongoing saga, there was information posted related to the backstory of how the documentation effort has progressed from inception to the current process for the creation of documentation, for example:

BP Documentation choices

  • July 12, 2023: use BuddyPress code repository to reorganize/migrate/update/improve the BuddyPress Codex.
  • January 10, 2024: create this repository to track BuddyPress Codex migration tasks as well as new documentation tasks.
  • January 24, 2024: using GitHub to contribute on the next BuddyPress documentation is our choice & it’s a good one!

Note: This agenda item is slated to be on the agenda for the next documentation meeting as a continuance.

3️⃣ Open Floor:

There were no conversations nor comments to report for this agenda item.

Next Docs-Chat

NOTE: The docs-chat meeting that was scheduled for August 6, 2025 is cancelled due to a conflict in schedule for @emaralive.

Our next documentation meeting will, tentatively, happen on August 20, 2025 at 19:00 UTC in #BuddyPress.

#docs-chat, #documentation, #summary

Unknown's avatar emaralive 1:19 pm on July 22, 2025
Tags: , , documentation   

BP Docs-Chat Agenda July 23, 2025

Hi!

Our next documentation meeting will happen on July 23, 2025, at 19:00 UTC in #BuddyPress. Here’s our agenda:

1️⃣ BP Documentation tracker status.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 11

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

  • General discussion – 2nd feasibility study – Docusaurus – example of use: WordPress Playground

Phase 2 feasibility studies status

  • In progress ❗ :
  • To Do:
  • Completed ⭐ :
    • Woocommerce REST API documentation, based on Slate – proposed here – awaiting final report (star to be appended when final report has been published)

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

3️⃣ Open Floor

If you have specific or additional points to discuss, please do so in the comments section of this post.

#agenda, #docs-chat, #documentation

Unknown's avatar emaralive 9:59 pm on July 21, 2025
Tags: , documentation,   

BP Docs-Chat Summary July 9, 2025

To Note: async (asynchronous) is a situation when an individual is not present during the meeting but, made an effort to make their presence known after the adjournment of the meeting. Additionally, user handles are taken from their respective Slack accounts and may not match up to WordPress.com accounts.

1️⃣ BP Documentation tracker status:

The stats – 58%, there was no change in percentage points – 58% ➡ 58%

NOTE: The stats remained flat due to no new issues were submitted and completions remained the same..

There is 1 (one) issue that is currently In Progress. For details see the In Progress section (Note: Project views are dynamic and are subject to change without notice).

Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 10:

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

General discussion – 2nd feasibility study – Docusaurus – example of use: WordPress Playground

The conversation was basically a first look at the Docusaurus  tool and based on the implementation by the WordPress (WP) Playground team, this tool looks like it might be a nice fit for the 3 BuddyPress (BP) handbooks (User, Developer & Contributor). At this time, the tool had not been installed (locally) by @emaralive and he had indicated that he had queued up a couple of the online demos that were provided by the tool makers.

A main feature is SPA (Single Page Application); Internationalization (i18n) is another feature of which @rollybueno (async) indicated that he had translated documents for the WP Playground project (see Translation: Tagalog (Filipino) #2336).

@dcavins indicated “[t]he result is screaming fast to use” which the tool makers claim:

Lightning-fast. Docusaurus v2+ follows the PRPL Pattern that makes sure your content loads blazing fast.

Phase 2 feasibility studies status

  • In progress:
  • To Do:
  • Completed:
    • Woocommerce REST API documentation, based on Slate – proposed here. – awaiting final report (star to be appended when final report has been published)

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

To provide context to this ongoing saga, there was information posted related to the backstory of how the documentation effort has progressed from inception to the current process for the creation of documentation, for example:

BP Documentation choices

  • July 12, 2023: use BuddyPress code repository to reorganize/migrate/update/improve the BuddyPress Codex.
  • January 10, 2024: create this repository to track BuddyPress Codex migration tasks as well as new documentation tasks.
  • January 24, 2024: using GitHub to contribute on the next BuddyPress documentation is our choice & it’s a good one!

Note: This agenda item is slated to be on the agenda for the next documentation meeting as a continuance.

3️⃣ Open Floor:

This agenda item was forgone due to an interruption in conversations caused by other pressing matters.

Next Docs-Chat

Our next documentation meeting will happen on July 23, 2025 at 19:00 UTC in #BuddyPress.

#docs-chat, #documentation, #summary

Unknown's avatar emaralive 8:01 pm on July 7, 2025
Tags: , , documentation   

BP Docs-Chat Agenda July 9, 2025

Hi!

Our next documentation meeting will happen on July 9, 2025, at 19:00 UTC in #BuddyPress. Here’s our agenda:

1️⃣ BP Documentation tracker status.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 10

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

  • General discussion – 2nd feasibility study – Docusaurus – example of use: WordPress Playground

Phase 2 feasibility studies status

  • In progress ❗ :
  • To Do:
  • Completed ⭐ :
    • Woocommerce REST API documentation, based on Slate – proposed here – awaiting final report (star to be appended when final report has been published)

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

3️⃣ Open Floor

If you have specific or additional points to discuss, please do so in the comments section of this post.

#agenda, #docs-chat, #documentation

Unknown's avatar emaralive 7:03 pm on July 7, 2025
Tags: , documentation,   

BP Docs-Chat Summary June 25, 2025

To Note: async (asynchronous) is a situation when an individual is not present during the meeting but, made an effort to make their presence known after the adjournment of the meeting. Additionally, user handles are taken from their respective Slack accounts and may not match up to WordPress.com accounts.

1️⃣ BP Documentation tracker status:

The stats – 58%, there was no change in percentage points – 58% ➡ 58%

NOTE: The stats remained flat due to no new issues were submitted and completions remained the same..

There is 1 (one) issue that is currently In Progress. For details see the In Progress section (Note: Project views are dynamic and are subject to change without notice).

Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 9:

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

General discussion – 1st feasibility study – Slate Docs

There were a couple of tests that were failing while deploying to the experimental repository (bp-rest-api-docs) that were related to Ruby versions 2.6 & 2.7. These failures appear to be attributed to upgrading the Bundler version to 2.5.3 which is currently compatible with Ruby version 3.x and not prior versions. Most likely, the testing for Ruby versions of 2.6 & 2.7 should be removed, given that the dependencies have been upgraded to be compatible with Ruby version 3.x.

The Slate tool analysis is basically complete, a documented report will be forthcoming, when time is available.

Phase 2 feasibility studies status

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

To provide context to this ongoing saga, there was information posted related to the backstory of how the documentation effort has progressed from inception to the current process for the creation of documentation, for example:

BP Documentation choices

  • July 12, 2023: use BuddyPress code repository to reorganize/migrate/update/improve the BuddyPress Codex.
  • January 10, 2024: create this repository to track BuddyPress Codex migration tasks as well as new documentation tasks.
  • January 24, 2024: using GitHub to contribute on the next BuddyPress documentation is our choice & it’s a good one!

Note: This agenda item is slated to be on the agenda for the next documentation meeting as a continuance.

3️⃣ Open Floor:

There was a support forum topic, BuddyPress plugin not tested with my WP version, which brought to light that the latest version (14.3.4) of BuddyPress is only compatible up to WordPress 6.7.2. There was some discussion on how to handle the next upgrade, however the date for release is still yet to be proposed/determined due to not having a list of bug fixes, etc. that would be included within this next release.

Another topic of interest was an issue with fonts as rendered by various browsers and operating systems. an example is a reply to a support forum topic, cant find all the buddypress widgets, whereby some of the text should have rendered as bold. For example, @emaralive indicated that for Chrome based browsers on a Linux 64 bit distro, what should have been bold text does not appear as bold, however, @dcavins indicated that on a Mac with Firefox and Vivaldi the bold text is rendered as such.

Next Docs-Chat

Our next documentation meeting will happen on July 9, 2025 at 19:00 UTC in #BuddyPress.

#docs-chat, #documentation, #summary

Unknown's avatar emaralive 1:04 am on June 24, 2025
Tags: , , documentation   

BP Docs-Chat Agenda June 25, 2025

Hi!

Our next documentation meeting will happen on June 25, 2025, at 19:00 UTC in #BuddyPress. Here’s our agenda:

1️⃣ BP Documentation tracker status.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 9

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

  • General discussion – 1st feasibility study – Slate Docs

Phase 2 feasibility studies status

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

3️⃣ Open Floor

If you have specific or additional points to discuss, please do so in the comments section of this post.

#agenda, #docs-chat, #documentation

Unknown's avatar emaralive 7:45 pm on June 23, 2025
Tags: , documentation,   

BP Docs-Chat Summary June 11, 2025

To Note: async (asynchronous) is a situation when an individual is not present during the meeting but, made an effort to make their presence known after the adjournment of the meeting. Additionally, user handles are taken from their respective Slack accounts and may not match up to WordPress.com accounts.

Summary: There was only one real-time participant (@emaralive) for this meeting: meaning anyone who added a “reaction” or commented after the fact was included as an asynchronous attendee.

1️⃣ BP Documentation tracker status:

The stats – 58%, there was no change in percentage points – 58% ➡ 58%

NOTE: The stats remained flat due to no new issues were submitted and completions remained the same..

There is 1 (one) issue that is currently In Progress. For details see the In Progress section (Note: Project views are dynamic and are subject to change without notice). The information covered was related the use of Docker as it pertained to the Slate Docs tool, e.g. “Using Slate in Docker”.

Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 8:

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

Update on the progress of the 1st feasibility study – Slate Docs

Using Slate in Docker – The Docker method proved to be outdated when pulling the “Slate Docs” image from the Docker Hub. It appears the dependency requirements were for Ruby 2.6 which was applicable at the time when Docker image and file known as “Dockerfile” were created and the same was apparently true for the Vagrant method. Updating “Dockerfile” to change the Ruby version from 2.6 to 3.3 along with updating “Gemfile” with the addition of  4 more Ruby gems and then using the “docker build” command created a Docker image that will now successfully build and serve the HTML documents.

All this means is that whichever method(s) is/are provided for building the BP REST API documents via the Slate tool, will have to be maintained to ensure a reliable build process, e.g., checked to make sure that there are no conflicts with dependencies as updates are made to those dependencies.

Phase 2 feasibility studies status

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

To provide context to this ongoing saga, there was information posted related to the backstory of how the documentation effort has progressed from inception to the current process for the creation of documentation, for example:

BP Documentation choices

  • July 12, 2023: use BuddyPress code repository to reorganize/migrate/update/improve the BuddyPress Codex.
  • January 10, 2024: create this repository to track BuddyPress Codex migration tasks as well as new documentation tasks.
  • January 24, 2024: using GitHub to contribute on the next BuddyPress documentation is our choice & it’s a good one!

Note: This agenda item is slated to be on the agenda for the next documentation meeting as a continuance.

3️⃣ Open Floor:

There were a couple of comments regarding an individual’s inability to attend this meeting in real-time, e.g. scheduling conflicts.

Next Docs-Chat

Our next documentation meeting will happen on June 25, 2025 at 19:00 UTC in #BuddyPress.

#docs-chat, #documentation, #summary

Unknown's avatar emaralive 6:43 pm on June 9, 2025
Tags: , documentation,   

BP Docs-Chat Summary May 28, 2025

BP Documentation tracker status:

The stats – 58%, there was no change in percentage points – 58% ➡ 58%

NOTE: The stats remained flat due to no new issues were submitted and completions remained the same..

There is 1 (one) issue that is currently In Progress. For details see the In Progress section (Note: Project views are dynamic and are subject to change without notice).

Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.

Continuation of the “revisit for the Update README with Documentation roadmap” – Part 7:

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

Update on the progress of the 1st feasibility study – Slate Docs

Progress thus far has been:

The GH pages site was built and deployed via the “Using Slate Natively” method on a Centos based Linux distro and to note, there are 3 methods provided: for the supported platforms of Mac and Linux (Windows is unsupported):

  • Using Slate Natively
  • Using Slate in Vagrant
  • Using Slate in Docker

The Vagrant method revealed that this method was a bit out of date with the required dependencies that had to be installed. For example, the Linux distro was out of date which made other packaged dependencies for the distro to be out of date and so forth, all of which are specified in a file known as “Vagrantfile”. Upgrading the distro as well as Nodejs in “Vagrantfile” allowed for a successful installation.

Next up is to evaluate the Docker method. One thing to note is that WooCommerce utilizes the Docker method which is apparently their preference.

New tool Scalar introduced here (#buddypress slack channel) on May 21, 2025

There was a quick peek at the following:

We weren’t sure if this tool (Scalar) would be applicable for our use, however, it may be listed in the feasibility study as an alternative tool.

Phase 2 feasibility studies status

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

To provide context to this ongoing saga, there was information posted related to the backstory of how the documentation effort has progressed from inception to the current process for the creation of documentation, for example:

BP Documentation choices

  • July 12, 2023: use BuddyPress code repository to reorganize/migrate/update/improve the BuddyPress Codex.
  • January 10, 2024: create this repository to track BuddyPress Codex migration tasks as well as new documentation tasks.
  • January 24, 2024: using GitHub to contribute on the next BuddyPress documentation is our choice & it’s a good one!

Note: This agenda item is slated to be on the agenda for the next documentation meeting as a continuance.

Open Floor:

There was a brief moment for Open floor, but it ended up being, more or less, the continuance of the 2nd agenda item.

Next Docs-Chat

Our next documentation meeting will happen on June 11, 2025 at 19:00 UTC in #BuddyPress.

#docs-chat, #documentation, #summary

Unknown's avatar emaralive 10:16 pm on May 26, 2025
Tags: , , documentation   

BP Docs-Chat Agenda May 28, 2025

Hi!

Our next documentation meeting will happen on May 28, 2025, at 19:00 UTC in #BuddyPress. Here’s our agenda:

1️⃣ BP Documentation tracker status.

2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 7

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

  • Update on the progress of the 1st feasibility study – Slate Docs
  • New tool Scalar introduced here (#buddypress slack channel) on May 21, 2025

Phase 2 feasibility studies status

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

3️⃣ Open Floor

If you have specific or additional points to discuss, please do so in the comments section of this post.

#agenda, #docs-chat, #documentation

Unknown's avatar emaralive 6:12 pm on May 26, 2025
Tags: , documentation,   

BP Docs-Chat Summary May 14, 2025

To Note: async (asynchronous) is a situation when an individual is not present during the meeting but, made an effort to make their presence known after the adjournment of the meeting. Additionally, user handles are taken from their respective Slack accounts and may not match up to WordPress.com accounts.

Summary: Due to @dcavins having to leave the meeting early, the meeting was adjourned after 30 minutes. There were 2 main points for the agenda regarding the 2nd item (Continuation of the “revisit for the Update README with Documentation roadmap” – Part 6):

  • Finish up on any additional comments regarding the Slate tool, e.g., what info should be included in the feasibility study?
  • Determine the next tool to be slated for a feasibility study

BP Documentation tracker status:

The stats – 58%, there was no change in percentage points – 58% ➡ 58%

NOTE: The stats remained flat due to no new issues were submitted and completions remained the same..

There is 1 (one) issue that is currently In Progress. For details see the In Progress section (Note: Project views are dynamic and are subject to change without notice).

Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.

The anomaly (truncated entries) with exporting view data while in Board layout was still present.

Continuation of the “revisit for the Update README with Documentation roadmap” – Part 6:

Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“

Regarding “additional comments” for the feasibility study that is “in progress”, some points of interest conveyed were:

  • The original Slate repo had been forked.
  • Installation of some required software, e.g. Ruby, etc., will occur.
  • Cloning of the forked repo locally will occur.
  • Attempt to build and deploy locally – using Slate natively

As for “which tool should be up next for a feasibility study“, there was concurrence that the next tool as listed in the “To Do” section would be an adequate approach; meaning, the “Docusaurus” tool will be up next.

Phase 2 feasibility studies status

❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.

To provide context to this ongoing saga, there was information posted related to the backstory of how the documentation effort has progressed from inception to the current process for the creation of documentation, for example:

BP Documentation choices

  • July 12, 2023: use BuddyPress code repository to reorganize/migrate/update/improve the BuddyPress Codex.
  • January 10, 2024: create this repository to track BuddyPress Codex migration tasks as well as new documentation tasks.
  • January 24, 2024: using GitHub to contribute on the next BuddyPress documentation is our choice & it’s a good one!

Note: This agenda item is slated to be on the agenda for the next documentation meeting as a continuance.

Open Floor:

Due to a limiting factor of a 30 minute time constraint (as noted in the summary), there was only time for @dcavins to express his interest by stating:

I am interested to see how easily these various documentation software answers will work.

Next Docs-Chat

Our next documentation meeting will happen on May 28, 2025 at 19:00 UTC in #BuddyPress.

#docs-chat, #documentation, #summary