Merge pull request #696 from denny/docs/rake-tasks

Add documentation file for rake tasks. Move Contributing doc to where GitHub expects it to be.

Author: denny

config/routes.rb

@@ -163,7 +163,7 @@ def sidekiq_web_enabled?
 
     ########################################################################################################
     # This route explicitly intercepts any request starting with /admin that wasn't otherwise handled
-    match '/admin/*path', to: 'admin#not_found', as: :admin_404, via: %i[ get post put patch delete ]
+    match '/admin/*path', to: 'admin#not_found', as: :admin_not_found, via: %i[ get post put patch delete ]
 
     ########################################################################################################
     # This catch-all route matches anything and everything not already matched by a route defined before it.

docs/Developers/Contributing.md renamed to docs/Contributing.md

@@ -4,20 +4,13 @@
 
 If you're interested in contributing to ShinyCMS ... let me start by saying "Thank you!" :)
 
-Here are some things to read that you might find useful:
+If you already know what feature or fix you want to work on, then it's the usual process; fork the repo, do your thing, submit a PR when you have your new code working. Please make sure it has full test coverage.
 
-* [Project goals](ProjectGoals.md)
+If you're generally interested in getting involved, but don't have a specific task in mind, here are some things to read that you might find useful:
 
-* Project progress:
-    * [Done](done.md)
-    * [In progress](in-progress.md)
-    * [Still to do](TODO.md)
+* [Project goals](Developers/ProjectGoals.md)
 
-* Instructions for [creating a new plugin](Plugins.md) (and related useful info)
-
-* Tools and tips for [working on mailers](Mailers.md) (features that send email)
-
-* Tools and rules for [testing](Testing.md) (this project has 100% test coverage)
+* [Developer documentation](Developers/index.md)
 
 
 ### Are you new to coding?
@@ -31,7 +24,7 @@ When I first started contributing to open source projects, I received a lot of i
 
 ## Code of Conduct
 
-This project has a [Code of Conduct](../code-of-conduct.md), which is intended
+This project has a [Code of Conduct](code-of-conduct.md), which is intended
 to make using ShinyCMS, or contributing to it, a harassment-free experience for
 everybody involved - regardless of who they are and what they do or don't know.
 

docs/Developers/TODO.md

@@ -131,6 +131,8 @@
 
 * Invites: https://github.com/scambra/devise_invitable#readme
 
+* Image galleries / multimedia galleries / etc
+
 * Can I merge EmailRecipient, CommentAuthor, and VotableIP into a single Visitor model?
     * Think carefully about privacy implications of linking previous actions to current visitor
 

docs/Developers/demo-data.md

@@ -0,0 +1,9 @@
+# ShinyCMS Developer Documentation
+
+## Demo site data
+
+The demo site data can be dumped and loaded using the rake tasks:
+
+`rails shiny:demo:dump` - this will dump the current contents of the database into `db/demo_data.rb` (only from models that include ShinyDemoDataProvider)
+
+`rails shiny:demo:load` - and reply 'Y' to the 'Are you sure?' question - this will wipe your database!

docs/Developers/index.md

@@ -0,0 +1,35 @@
+# ShinyCMS Developer Documentation
+
+## Goals and Progress
+
+This is as close as we get to a roadmap, for now :)
+
+* [Project goals](ProjectGoals.md)
+
+* Project progress:
+    * [Done](done.md)
+    * [In progress](in-progress.md)
+    * [Still to do](TODO.md)
+
+
+## Useful Links
+
+* [GitHub issues](https://github.com/denny/ShinyCMS-ruby/issues)
+
+
+## Technical Guides
+
+* Instructions for [creating a new plugin](Plugins.md) (and related useful info)
+
+* Tools and tips for [working on mailers](Mailers.md) (features that send email)
+
+* Tools and rules for [testing](Testing.md) (this project has 100% test coverage)
+
+
+## Code of Conduct
+
+This project has a [Code of Conduct](../code-of-conduct.md), which is intended
+to make using ShinyCMS, or contributing to it, a harassment-free experience for
+everybody involved - regardless of who they are and what they do or don't know.
+
+Please read and follow the code of conduct - thank you.

docs/rake-tasks.md

@@ -0,0 +1,18 @@
+# ShinyCMS Documentation
+
+## Rake tasks
+
+ShinyCMS and its plugins include a number of rake tasks.
+
+The bulk of these are the 'install migrations' and 'load db seeds' tasks for each plugin; in the case that a plugin lacks one or both of these tasks, it will be because the nature of the plugin means that it doesn't store data in the database (e.g. ShinySearch) and/or it doesn't have any settings or feature flags (so far I don't think this is actually true of any plugin).
+
+Aside from those db loading tasks, here's what's left:
+```
+rails shiny:admin:create                # create a new super-admin user (all capabilities enabled)
+rails shiny:demo:load                   # reset database, create admin user, and load demo site data
+rails shiny:demo:dump                   # dump current database content into db/demo_data.rb
+rails shiny:feature:off[name]           # toggle a feature flag off
+rails shiny:feature:on[name]            # toggle a feature flag on
+rails shiny:features:list               # list feature flags and status
+rails shiny_newsletters:scheduled:send  # check for and start any scheduled sends that are due
+```

plugins/ShinyNewsletters/lib/tasks/shiny_newsletters_sends.rake

@@ -18,10 +18,10 @@ require 'dotenv/tasks'
 # These two tasks can be run in either order.
 
 namespace :shiny_newsletters do
-  namespace :sends do
+  namespace :scheduled do
     # :nocov:
-    desc 'ShinyCMS: add Newsletter send jobs to queue, if due'
-    task queue_if_due: %i[ environment dotenv ] do
+    desc 'ShinyCMS: check for and start any scheduled sends that are due'
+    task send: %i[ environment dotenv ] do
       ShinyNewsletters::Send.due_to_send.collect( &:start_sending )
     end
     # :nocov: