backdrop-contrib / demo

Manage snapshots of a Backdrop site for demo purposes.
https://backdropcms.org/project/demo
GNU General Public License v2.0
1 stars 3 forks source link

Improve README file and project page. #27

Closed izmeez closed 1 year ago

izmeez commented 1 year ago

I see how the README file is similar to the file in the Drupal module but I think it may be improved by emphasizing the two distinct uses. The first paragraph could be replaced with:

`The Demo module has two main uses:

  1. It can be used to create and restore snapshots of a site with a simple click that can be useful when testing modules and during development.

  2. With the included, optional Demo Reset module it can be used to setup a public demonstration site; a sandbox for visitors to use, that is automatically reset periodically using cron.`

Along the same lines the project page, https://backdropcms.org/project/demo could be changed.

It could be taken further with including the difference with it and backup_migrate as described in the forum topic, https://forum.backdropcms.org/forum/demo-module-great-snapshots-and-testing

The demo module also saves the config files and restores them on reset, something that the backup_migrate module does not do.

izmeez commented 1 year ago

Also the project page title could be enhanced similar to the Drupal project page,

Demonstration site (Sandbox / Snapshot)

robertgarrigos commented 1 year ago

I agree that the first paragraph would need to reflect its testing capability. However, the first paragraph needs to be formatted as one single paragraph of no more than 240 characters as it used as the project summary on b.org

izmeez commented 1 year ago

What about:

The Demo module has two main uses. It can be used to create and restore snapshots of a site with a simple click that can be useful when testing modules and during development. Also, with the included optional Demo Reset module it can be used to setup a public demonstration site, a sandbox for visitors to use, that is automatically reset periodically using cron.

izmeez commented 1 year ago

Do we need more feedback on this?

robertgarrigos commented 1 year ago

Nop. Just some time to make the pr ;-)