Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
justdave committed Apr 29, 2023
1 parent 8011cf9 commit ec34687
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,24 @@ You can see a live version of this at https://mishigami.org/ue-dashboard/

## Installation

This is NOT ready for a general release yet. If you use it before it's ready, you'll need to manually update from Git periodically. My goal is to eventually have this auto-update like any other plugin.
This has not yet been uploaded to the WordPress Plugin Directory, which means it will not auto-update. Until that happens, you'll need to check the GitHub page to see if there's a new release. It should update itself once it shows up in the Plugin Directory.

### The easy way

1. Download the zip file from the Releases page on GitHub
1. upload it to the Plugins screen in the WordPress admin section.
1. Go to **Plugins** in the WordPress admin, then Activate the plugin
1. Go to **OA Tools > Upload Inductions Data** in the WordPress admin, and follow the instructions there to import data from LodgeMaster.
1. Create one or more pages for your charts or tables, and put the shortcodes where you want them to show up.

### If you want to work on the code

1. `cd` into the `wp-content/plugins` directory within your WordPress installation.
1. Use `git clone` to check out the source
1. Use `git clone` to check out the source from GitHub
1. `cd` into the new `oa-unit-election-statistics` folder
1. Run `composer install` to install the dependencies.
1. Go to **Plugins** in the WordPress admin, then Activate the plugin
1. Go to **OA Tools > Import Inductions Data** in the WordPress admin, and follow the instructions there to import data from LodgeMaster.
1. Go to **OA Tools > Upload Inductions Data** in the WordPress admin, and follow the instructions there to import data from LodgeMaster.
1. Create one or more pages for your charts or tables, and put the shortcodes where you want them to show up.

## Usage
Expand All @@ -30,7 +40,3 @@ Each chart or table is a shortcode. You can place the shortcode wherever you wan
<dd>Generates a table separated by chapter listing all of the units who have submitted election reports, listing how many youth were elected, how many adults they're eligible for, how many adults have been nominated so far, and how many adults they can still nominate, with a subtotal for each chapter.</dd>
</dl>

## TODO before this can be considered production quality:

* Outfit the plugin with the tooling for WordPress to be able to detect its version and auto-update it.
* Fix all the copyright dates and license headers.
4 changes: 2 additions & 2 deletions includes/admin-settings.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ function oa_tools_menu() {

add_action('admin_menu', 'oauestats_config_menu', 9);
function oauestats_config_menu() {
add_submenu_page( "oa_tools", "Upload Induction Data", "Upload Induction Data", 'manage_options', 'oauestats_upload_data', 'oauestats_upload_data');
add_submenu_page( "oa_tools", "Upload Inductions Data", "Upload Inductions Data", 'manage_options', 'oauestats_upload_data', 'oauestats_upload_data');
}
function oauestats_upload_data() {
global $wpdb;
Expand Down Expand Up @@ -313,7 +313,7 @@ function oauestats_upload_data() {

?>
<div class="wrap">
<h2>Update Inductions Data</h2>
<h2>Upload Inductions Data</h2>
<form action="" method="post" enctype="multipart/form-data">
<p>This requires two files exported from OALM:</p>
<ol>
Expand Down

0 comments on commit ec34687

Please sign in to comment.