Skip to content

Conversation

@emaralive
Copy link
Contributor

Create documentation files for the Site Health Screen within the User Handbook.

bp-documentation issue: buddypress/bp-documentation#4


This Pull Request is for code review only. Please keep all other discussion in the BuddyPress Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the WordPress Core Handbook for more details.

@emaralive emaralive added the documentation Pull Request about documenting BuddyPress label Oct 22, 2024
@emaralive emaralive self-assigned this Oct 22, 2024
@emaralive emaralive requested a review from imath October 22, 2024 14:00
@emaralive
Copy link
Contributor Author

@imath - I just noticed that changesets 14049 & 14050 changed/corrected the value for BP_XPROFILE_BASE_GROUP_NAME which requires an update to this PR (a screenshot & text).

That stated, I will wait for your initial review and then update this PR with the aforementioned changes I've noticed , along with any additional changes that may be required by your review.

@emaralive emaralive force-pushed the 4-add-buddypress-site-health-panel branch from a224f0e to be4a370 Compare October 24, 2024 22:52
@emaralive
Copy link
Contributor Author

@imath - I went ahead and pushed the changes, so take another look.

imath
imath previously requested changes Oct 27, 2024
Copy link
Contributor

@imath imath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @emaralive

First: thank you so much for this impressive work. Great job.

Then, I believe the site-health part should be put inside the user/administration folder & I think it would be nice to quickly explain what are these constants role.

@emaralive
Copy link
Contributor Author

emaralive commented Oct 28, 2024

@imath - Thanks for your input/suggestion and I'll try to speak to this as a summarization.

Suggestions for additional info for Constants

As it stands, there is a current issue [Migrate]: Filters & Constants Reference #127 which I had planned to take care of the descriptions/definitions for constants (explain the role of each Constant) of which I've already started a rough draft. That stated, I can take your suggestions and apply/incorporate them to the aforementioned BuddyPress Constants document. In fact your suggestions has sped up the process because I was having to look at the code in an attempt to understand the nature of each Constant, meaning some of us don't have the luxury of knowing BuddyPress as well as you do (it takes time for some of us to get up to speed).

When the BuddyPress Constants document is eventually completed, a link or links (depending on what will present itself as practical) can be added to this document (site-health.md) as an update (create an update issue to handle this task).

Additionally, site-health.md has only 47 Constants and constants.md has the full complement of 50 Constants plus compartmentalized to facilitate the further understanding of the roles.

Furthermore, I would like this document to get finalized and improvements/enhancements made at a later date (aforementioned link or links) due to needing a source for a link within the Help tab for the Site Health screen/page which requires a Trac ticket and patch to accomplish this, of which should be included with the 15.0 release.

Inclusion of site-health.md with the administration folder

I don't have a problem with this, I just have to:

  • Move site-health.md into the administration folder and update the relative links, accordingly, e.g., screenshots, other .md files.
  • Remove a link from the current linked README.md and add a link to the README.md in the administration folder.
  • Update the manifest.json file accordingly.

If we can agree/concur on my proposal, I can make these changes and push another commit. Otherwise, we can continue this conversation in an attempt to get closer to an agreement/consensus. So, either way, let me know.

In the meantime, I'm looking into what it will take to update the V1 BP REST API handbook on developer.buddypress.org. Currently, it looks like updates to 22 pages with multiple places on each page, as well as continuing work on rough draft for the BuddyPress Constants document.

@imath
Copy link
Contributor

imath commented Oct 28, 2024

@emaralive thanks for your explanations. I'm fine with using a different document to explain constant roles. I believe in this case we can simplify the current document: use a unique link to the constants documentation page once it'll be ready instead of the current table. My point is I don't see the benefit of copying what's inside the Admin Screen if we don't provide meaningful information 😁.

@emaralive emaralive force-pushed the 4-add-buddypress-site-health-panel branch from be4a370 to 8599098 Compare October 29, 2024 13:17
@emaralive emaralive requested a review from imath October 29, 2024 13:25
@emaralive emaralive dismissed imath’s stale review October 29, 2024 13:30

Strategy for suggested changes has changed, whereas the changes will be incorporated into a different document (constants.md) & PR.

Copy link
Contributor

@imath imath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @emaralive thanks for your changes and great work. I'll SVN Commit the PR asap 👌

@emaralive emaralive deleted the 4-add-buddypress-site-health-panel branch November 6, 2024 22:46
emaralive pushed a commit to emaralive/omt-buddypress-sync that referenced this pull request Nov 2, 2025
emaralive pushed a commit to emaralive/buddypress-sync that referenced this pull request Nov 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull Request about documenting BuddyPress

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants