Add documentation for import types (full, force, safe)

Agreed the module page documentation needs work before we add it to README, the module page, and drush help. And maybe the functionality needs updating to better match the documentation…

Most important thing to understand/document is that "force" should be called "destructive"

By deleting everything first, "force" severs any connection existing content had with your custom block, menu item, or taxonomy term, if that relationship is based on entity ID. This is mainly a problem for taxonomy terms. Using "force" will delete all the terms from any content you have, and recreate them with new term IDs and no relation to your content anymore.

I think that documentation is best in the module, module page, or README but Drupal documentation is very useful for extended documentation and working on docs collaboratively so i've started this guide:

https://www.drupal.org/docs/extending-drupal/contributed-modules/structu... →

(When it is ready, it would have to be linked to from the structure sync module page by an admin.)

Thank you @mlncn

I added a "Documentation" link in the Ressource section

Thanks @mlncn and @louis-cuny. I added the Drush commands and import choices to https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib... → from the project page so that the community can pitch in with writing the documentation. On the project page, only maintainers can update.

I just did some menu synchronization. I first tried with drush import:menus --choice=safe, which caused all menu items to be duplicated, but drush import:menus --choice=full worked well. So an extra section, or just a comment or two about how choices and menus work together would be nice on that page.

Also, the order of commands during export and import could be added as well, something like this? (please correct if wrong ...)

1. Develop locally and export
   

   drush export:menus
   drush config:export
   

2. Import on the server
   

   drush config:import
   drush import:menus --choice=full
   

I added the export and import steps under https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib... →