-
Notifications
You must be signed in to change notification settings - Fork 169
Create documentation files for Site Health Screen in User Handbook #390
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create documentation files for Site Health Screen in User Handbook #390
Conversation
|
@imath - I just noticed that changesets 14049 & 14050 changed/corrected the value for 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. |
a224f0e to
be4a370
Compare
|
@imath - I went ahead and pushed the changes, so take another look. |
imath
left a comment
There was a problem hiding this 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.
|
@imath - Thanks for your input/suggestion and I'll try to speak to this as a summarization. Suggestions for additional info for ConstantsAs 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 folderI don't have a problem with this, I just have to:
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 |
|
@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 😁. |
be4a370 to
8599098
Compare
Strategy for suggested changes has changed, whereas the changes will be incorporated into a different document (constants.md) & PR.
imath
left a comment
There was a problem hiding this 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 👌
Props emaralive. Closes buddypress/buddypress#390 git-svn-id: http://buddypress.svn.wordpress.org/trunk@14065 cdf35c40-ae34-48e0-9cc9-0c9da1808c22
Props emaralive. Closes buddypress/buddypress#390 git-svn-id: https://buddypress.svn.wordpress.org/trunk@14065 cdf35c40-ae34-48e0-9cc9-0c9da1808c22
Props emaralive. Closes buddypress/buddypress#390 git-svn-id: https://buddypress.svn.wordpress.org/trunk@14065 cdf35c40-ae34-48e0-9cc9-0c9da1808c22
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.