<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][14065] trunk/docs/user: Document the 2 panels BuddyPress adds to WP Site Health Admin Screen</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/14065">14065</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/14065","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-10-30 18:30:39 +0000 (Wed, 30 Oct 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Document the 2 panels BuddyPress adds to WP Site Health Admin Screen
Props emaralive.
Closes https://github.com/buddypress/buddypress/pull/390</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdocsuserREADMEmd">trunk/docs/user/README.md</a></li>
<li><a href="#trunkdocsuseradministrationREADMEmd">trunk/docs/user/administration/README.md</a></li>
<li><a href="#trunkdocsusermanifestjson">trunk/docs/user/manifest.json</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkdocsuseradministrationsitehealthmd">trunk/docs/user/administration/site-health.md</a></li>
<li><a href="#trunkdocsuserassetsshsbuddypressconstants03png">trunk/docs/user/assets/shs-buddypress-constants-03.png</a></li>
<li><a href="#trunkdocsuserassetsshsbuddypresspanel02png">trunk/docs/user/assets/shs-buddypress-panel-02.png</a></li>
<li><a href="#trunkdocsuserassetssitehealthscreenpng">trunk/docs/user/assets/site-health-screen.png</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdocsuserREADMEmd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/user/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/README.md 2024-10-30 18:12:37 UTC (rev 14064)
+++ trunk/docs/user/README.md 2024-10-30 18:30:39 UTC (rev 14065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,3 +7,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - [The BuddyPress Components](./components/README.md)
</span><span class="cx" style="display: block; padding: 0 10px"> - [BuddyPress Administration](./administration/README.md)
</span><span class="cx" style="display: block; padding: 0 10px"> - [Advanced customizations](./advanced/README.md)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins></span></pre></div>
<a id="trunkdocsuseradministrationREADMEmd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/user/administration/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/administration/README.md 2024-10-30 18:12:37 UTC (rev 14064)
+++ trunk/docs/user/administration/README.md 2024-10-30 18:30:39 UTC (rev 14065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,3 +9,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - Activity
</span><span class="cx" style="display: block; padding: 0 10px"> - [Groups](./groups/README.md)
</span><span class="cx" style="display: block; padding: 0 10px"> - [Emails](./emails/README.md)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+- [Site Health Screen](site-health.md)
</ins></span></pre></div>
<a id="trunkdocsuseradministrationsitehealthmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/administration/site-health.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/administration/site-health.md (rev 0)
+++ trunk/docs/user/administration/site-health.md 2024-10-30 18:30:39 UTC (rev 14065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,57 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# Site Health Screen
+> [!TIP]
+> Detailed information regarding the **Site Health** screen can be found at [Support guides/Dashboard/Site Health screen](https://wordpress.org/documentation/article/site-health-screen/).
+
+BuddyPress, currently, adds 2 (two) accordion panels to the **[Site Health Info](https://wordpress.org/documentation/article/site-health-screen/#info)** tab:
+
+1. **[BuddyPress](#1-buddypress)**
+2. **[BuddyPress Constants](#2-buddypress-constants)**
+> [!NOTE]
+> This information may prove instrumental in resolving site issues while communicating with support personnel, e.g., use the **Copy site info to clipboard** button and include any relevant information that will augment your support request.
+***
+![site health screen example](../assets/site-health-screen.png)
+An example of the **Site Health** screen
+
+### (1) BuddyPress
+This panel contains details about your BuddyPress configuration depending upon which components are enabled.
+
+![site health - BuddyPress panel](../assets/shs-buddypress-panel-02.png)
+
+The image above is an example of an expanded BuddyPress panel with minimum components enabled. Below is the full list of attributes and the component associated with each configurable attribute.
+
+> [!NOTE]
+> The **\*** (asterisk) indicates whether the **BuddyPress standalone theme** or the **Active template pack** attribute will be shown (not both). If no **BuddyPress standalone theme** is detected, then the fallback is to show the **Active template pack** attribute.
+>
+> Additionally, plugins may add **optional components** to the list of **Active components** attribute and/or add additional attributes.
+
+| Attribute | Description | Component |
+|:-------|:--------|:-------|
+| Version | The installed version of BuddyPress. | BuddyPress Core |
+| Active components | A list of active components. The defaults are **BuddyPress Core**, **Community Members**, **Extended Profiles**, **Account Settings**, **Activity Streams** & **Notifications**. Configurable from [BuddyPress Components](settings/components.md) screen, with the exceptions of **BuddyPress Core** & **Community Members** which are **Must-Use** components. | BuddyPress Core |
+| URL Parser | Indicates which URL Parser is in use. The default is **BP Rewrites API**. Can be changed to the **Legacy Parser** by installing the [BP Classic](https://wordpress.org/plugins/bp-classic/) add-on. | BuddyPress Core |
+| Community visibility | Indicates whether the BuddyPress community is public (**Anyone**) or private (**Members Only**). The Default is public (**Anyone**). Configurable from the [BuddyPress Options](settings/options.md#community-visibility) screen. | BuddyPress Core |
+| BuddyPress standalone theme\* | Indicates which BuddyPress standalone theme is in use. | BuddyPress Core |
+| Active template pack\* | Indicates which BuddyPress template pack is in use. The Default is **BuddyPress Nouveau**. Configurable from the [BuddyPress Options](settings/options.md#template-pack) screen. | BuddyPress Core |
+| Toolbar | Indicates whether the WordPress **Toolbar** is shown on the front-end for **logged out** users. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#toolbar) screen. See [Toolbar](https://wordpress.org/documentation/article/toolbar/) for additional information. | BuddyPress Core |
+| Account Deletion | Indicates whether registered members are allowed to delete their own accounts. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#account-deletion) screen. | Account Settings |
+| Community Members: Profile Photo Uploads | Indicates whether registered members are allowed to upload avatars. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#profile-photo-upload) screen. | Community Members |
+| Community Members: Cover Image Uploads | Indicates whether registered members are allowed to upload cover images. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#cover-image-upload) screen. | Community Members |
+| Community Members: Invitations | Indicates whether registered members are allowed to invite people to join the network. The Default is **disabled**. Configurable from the [BuddyPress Options](settings/options.md#invitations) screen. | Community Members |
+| Community Members: Membership Requests | Indicates whether visitors are allowed to request site membership. If enabled, an administrator must approve each new site membership request. The Default is **disabled**. Configurable from the [BuddyPress Options](settings/options.md#membership-requests) screen. ***Note**: The "**Anyone can register**" checkbox must be **disabled** in order to **enable** this feature (see [General Settings - Membership](https://wordpress.org/documentation/article/settings-general-screen/#membership) for where to **enable** or **disable** the "**Anyone can register**" checkbox)* | Community Members |
+| Extended Profiles: Profile Syncing | Indicates whether BuddyPress to WordPress profile syncing is allowed. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#profile-syncing) screen. | Extended Profiles |
+| User Groups: Group Creation | Indicates whether group creation for all users is allowed. Administrators can always create groups, regardless of this setting. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#group-creation) screen. | User Groups |
+| User Groups: Group Photo Uploads | Indicates whether customizable avatars for groups is allowed. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#group-photo-upload) screen. | User Groups |
+| User Groups: Group Cover Image Uploads | Indicates whether customizable cover images for groups is allowed. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#group-cover-image-upload) screen. | User Groups |
+| User Groups: Group Activity Deletions | Indicates whether group administrators and moderators to delete activity items from their group's activity stream is allowed. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md) screen. | User Groups |
+| Activity Streams: Post Comments | Indicates whether activity stream commenting on posts and comments is allowed. The Default is **disabled**. Configurable from the [BuddyPress Options](settings/options.md#post-comments) screen. ***Note**: The Site Tracking component must be **active** in order to **enable** this feature*. |Activity Streams & Site Tracking |
+| Activity Streams: Activity auto-refresh | Indicates whether a check for new items while viewing the activity stream is automatically allowed. The Default is **enabled**. Configurable from the [BuddyPress Options](settings/options.md#activity-auto-refresh) screen. |Activity Streams |
+
+### (2) BuddyPress Constants
+
+![site health - BuddyPress panel](../assets/shs-buddypress-constants-03.png)
+
+The image above is a truncated example of an expanded BuddyPress Constants panel.
+
+Some of these Constants are (**1**) user-definable and will alter the behavior of BuddyPress when their default values are overridden. while some Constants are reserved for (**2**) core/development use and, lastly, some Constants are (**3**) deprecated (**not recommeded for use**). The BuddyPress Constants panel has been made available for your purvey in the event a misdefined Constant may be causing unexpected behavior. More information is available at **[BuddyPress Constants - TBD]**.
+
+
</ins></span></pre></div>
<a id="trunkdocsuserassetsshsbuddypressconstants03png"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/assets/shs-buddypress-constants-03.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/docs/user/assets/shs-buddypress-constants-03.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/docs/user/assets/shs-buddypress-constants-03.png 2024-10-30 18:12:37 UTC (rev 14064)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/docs/user/assets/shs-buddypress-constants-03.png 2024-10-30 18:30:39 UTC (rev 14065)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/docs/user/assets/shs-buddypress-constants-03.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+image/png
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkdocsuserassetsshsbuddypresspanel02png"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/assets/shs-buddypress-panel-02.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/docs/user/assets/shs-buddypress-panel-02.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/docs/user/assets/shs-buddypress-panel-02.png 2024-10-30 18:12:37 UTC (rev 14064)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/docs/user/assets/shs-buddypress-panel-02.png 2024-10-30 18:30:39 UTC (rev 14065)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/docs/user/assets/shs-buddypress-panel-02.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+image/png
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkdocsuserassetssitehealthscreenpng"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/assets/site-health-screen.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/docs/user/assets/site-health-screen.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/docs/user/assets/site-health-screen.png 2024-10-30 18:12:37 UTC (rev 14064)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/docs/user/assets/site-health-screen.png 2024-10-30 18:30:39 UTC (rev 14065)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/docs/user/assets/site-health-screen.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+image/png
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkdocsusermanifestjson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/user/manifest.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/manifest.json 2024-10-30 18:12:37 UTC (rev 14064)
+++ trunk/docs/user/manifest.json 2024-10-30 18:30:39 UTC (rev 14065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,6 +48,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "parent": null
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "title": "Site Health Screen",
+ "slug": "site-health",
+ "markdown_source": "../user/administration/site-health.md",
+ "parent": null
+ },
+ {
</ins><span class="cx" style="display: block; padding: 0 10px"> "title": "BuddyPress settings",
</span><span class="cx" style="display: block; padding: 0 10px"> "slug": "administration-settings",
</span><span class="cx" style="display: block; padding: 0 10px"> "markdown_source": "../user/administration/settings/README.md",
</span></span></pre>
</div>
</div>
</body>
</html>