Skip to content

Commit fe66bf4

Browse files
committed
Update help messages in admin settings
Close mAAdhaTTah#120. More work will need to be done in the wiki to flesh this out.
1 parent 09a5d1a commit fe66bf4

2 files changed

Lines changed: 7 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,9 @@ If WPGHS cannot find the author for a given import, it will fallback to the defa
106106

107107
### Custom Post Type & Status Support ###
108108

109-
By default, WordPress <--> GitHub Sync only exports published posts and pages. If you want to export additional post types or draft posts, you'll have to hook into the filters `wpghs_whitelisted_post_types` or `wpghs_whitelisted_post_statuses` respectively.
109+
By default, WordPress <--> GitHub Sync only exports published posts and pages. However, it provides a number of [hooks](https://codex.wordpress.org/Plugin_API) in order to customize its functionality. Check out the [wiki](https://github.com/mAAdhaTTah/wordpress-github-sync/wiki) for complete documentation for these actions and filters.
110+
111+
If you want to export additional post types or draft posts, you'll have to hook into the filters `wpghs_whitelisted_post_types` or `wpghs_whitelisted_post_statuses` respectively.
110112

111113
In `wp-content`, create or open the `mu-plugins` folder and create a plugin file there called `wpghs-custom-filters.php`. In it, paste and modify the below code:
112114

@@ -159,15 +161,9 @@ If you'd like to include an edit link without modifying your theme directly, you
159161
return $content;
160162
}, 1000 );
161163

162-
### Using WPGHS to Keep Multiple Sites in Sync
163-
164-
This is an _advanced feature_. Your configuration may or may not be fully supported. **Use at your own risk.**
165-
166-
More information can be found in the [wiki](https://github.com/mAAdhaTTah/wordpress-github-sync/wiki).
167-
168164
### Additional Customizations ###
169165

170-
There are a number of other filters available in WordPress <--> GitHub Sync for customizing various parts of the export, including the commit message and YAML front-matter. Want more detail? Check out the [wiki](https://github.com/mAAdhaTTah/wordpress-github-sync/wiki).
166+
There are a number of other customizations available in WordPress <--> GitHub Sync, including the commit message and YAML front-matter. Want more detail? Check out the [wiki](https://github.com/mAAdhaTTah/wordpress-github-sync/wiki).
171167

172168
### Contributing ###
173169

‎lib/admin.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ public function register_settings() {
4040
add_settings_field( 'wpghs_host', __( 'GitHub hostname', 'wordpress-github-sync' ), array( $this, 'field_callback' ), WordPress_GitHub_Sync::$text_domain, 'general', array(
4141
'default' => 'https://api.github.com',
4242
'name' => 'wpghs_host',
43-
'help_text' => __( 'The GitHub host to use. Can be changed to support a GitHub Enterprise installation.', 'wordpress-github-sync' ),
43+
'help_text' => __( 'The GitHub host to use. This only needs to be changed to support a GitHub Enterprise installation.', 'wordpress-github-sync' ),
4444
)
4545
);
4646

4747
register_setting( WordPress_GitHub_Sync::$text_domain, 'wpghs_repository' );
4848
add_settings_field( 'wpghs_repository', __( 'Repository', 'wordpress-github-sync' ), array( $this, 'field_callback' ), WordPress_GitHub_Sync::$text_domain, 'general', array(
4949
'default' => '',
5050
'name' => 'wpghs_repository',
51-
'help_text' => __( 'The GitHub repository to commit to, with owner (<code>[OWNER]/[REPOSITORY]</code>), e.g., <code>github/hubot.github.com</code>. The repository should contain an initial commit.', 'wordpress-github-sync' ),
51+
'help_text' => __( 'The GitHub repository to commit to, with owner (<code>[OWNER]/[REPOSITORY]</code>), e.g., <code>github/hubot.github.com</code>. The repository should contain an initial commit, which is satisfied by including a README when you create the repository on GitHub.', 'wordpress-github-sync' ),
5252
)
5353
);
5454

@@ -64,7 +64,7 @@ public function register_settings() {
6464
add_settings_field( 'wpghs_secret', __( 'Webhook Secret', 'wordpress-github-sync' ), array( $this, 'field_callback' ), WordPress_GitHub_Sync::$text_domain, 'general', array(
6565
'default' => '',
6666
'name' => 'wpghs_secret',
67-
'help_text' => __( "The webhook's secret phrase.", 'wordpress-github-sync' ),
67+
'help_text' => __( "The webhook's secret phrase. This should be password strength, as it is used to verify the webhook's payload.", 'wordpress-github-sync' ),
6868
)
6969
);
7070

0 commit comments

Comments
 (0)