training/new_structure: A long way to go - new structure
sven <jenkins-z4DKO/[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.cvs |
|---|---|
| Message-ID | <[email protected]> |
Repository: training Branch: refs/heads/new_structure Date: 2017-07-17T11:23:13+02:00 Author: sven (svx) <[email protected]> Commit: https://github.com/plone/training/commit/f0db6dddb54094ea340356267b2c5f2eb44be334 A long way to go - new structure Files changed: A mastering-plone/about_mastering.rst A mastering-plone/add-ons.rst A mastering-plone/anatomy.rst A mastering-plone/api.rst A mastering-plone/behaviors_1.rst A mastering-plone/behaviors_2.rst A mastering-plone/buildout_1.rst A mastering-plone/case.rst A mastering-plone/code.rst A mastering-plone/configuring_customizing.rst A mastering-plone/custom_search.rst A mastering-plone/deployment_code.rst A mastering-plone/deployment_sites.rst A mastering-plone/development_bucarest.rst A mastering-plone/dexterity.rst A mastering-plone/dexterity_2.rst A mastering-plone/dexterity_3.rst A mastering-plone/eggs1.rst A mastering-plone/eggs2.rst A mastering-plone/embed.rst A mastering-plone/events.rst A mastering-plone/export_code.rst A mastering-plone/extending.rst A mastering-plone/features.rst A mastering-plone/frontpage.rst A mastering-plone/future_of_plone.rst A mastering-plone/grok.rst A mastering-plone/ide.rst A mastering-plone/index.rst A mastering-plone/installation.rst A mastering-plone/intro.rst A mastering-plone/optional.rst A mastering-plone/plone5.rst A mastering-plone/registry.rst A mastering-plone/relations.rst A mastering-plone/resources.rst A mastering-plone/restapi.rst A mastering-plone/reusable.rst A mastering-plone/roadmap.rst A mastering-plone/testing.rst A mastering-plone/theming.rst A mastering-plone/thirdparty_behaviors.rst A mastering-plone/timing.rst A mastering-plone/user_generated_content.rst A mastering-plone/viewlets_1.rst A mastering-plone/viewlets_2.rst A mastering-plone/views_1.rst A mastering-plone/views_2.rst A mastering-plone/views_3.rst A mastering-plone/zpt.rst A mastering-plone/zpt_2.rst A teachers-training/after.rst A teachers-training/before.rst A teachers-training/during.rst A teachers-training/index.rst A teachers-training/theory.rst A wip.rst D mastering_plone/about_mastering.rst D mastering_plone/add-ons.rst D mastering_plone/anatomy.rst D mastering_plone/api.rst D mastering_plone/behaviors_1.rst D mastering_plone/behaviors_2.rst D mastering_plone/buildout_1.rst D mastering_plone/case.rst D mastering_plone/code.rst D mastering_plone/configuring_customizing.rst D mastering_plone/custom_search.rst D mastering_plone/deployment_code.rst D mastering_plone/deployment_sites.rst D mastering_plone/development_bucarest.rst D mastering_plone/dexterity.rst D mastering_plone/dexterity_2.rst D mastering_plone/dexterity_3.rst D mastering_plone/eggs1.rst D mastering_plone/eggs2.rst D mastering_plone/embed.rst D mastering_plone/events.rst D mastering_plone/export_code.rst D mastering_plone/extending.rst D mastering_plone/features.rst D mastering_plone/frontpage.rst D mastering_plone/future_of_plone.rst D mastering_plone/grok.rst D mastering_plone/ide.rst D mastering_plone/index.rst D mastering_plone/installation.rst D mastering_plone/intro.rst D mastering_plone/optional.rst D mastering_plone/plone5.rst D mastering_plone/registry.rst D mastering_plone/relations.rst D mastering_plone/resources.rst D mastering_plone/restapi.rst D mastering_plone/reusable.rst D mastering_plone/roadmap.rst D mastering_plone/testing.rst D mastering_plone/theming.rst D mastering_plone/thirdparty_behaviors.rst D mastering_plone/timing.rst D mastering_plone/user_generated_content.rst D mastering_plone/viewlets_1.rst D mastering_plone/viewlets_2.rst D mastering_plone/views_1.rst D mastering_plone/views_2.rst D mastering_plone/views_3.rst D mastering_plone/zpt.rst D mastering_plone/zpt_2.rst D trainthetrainer/after.rst D trainthetrainer/before.rst D trainthetrainer/during.rst D trainthetrainer/index.rst D trainthetrainer/theory.rst diff --git a/mastering_plone/about_mastering.rst b/mastering-plone/about_mastering.rst similarity index 100% rename from mastering_plone/about_mastering.rst rename to mastering-plone/about_mastering.rst diff --git a/mastering_plone/add-ons.rst b/mastering-plone/add-ons.rst similarity index 100% rename from mastering_plone/add-ons.rst rename to mastering-plone/add-ons.rst diff --git a/mastering_plone/anatomy.rst b/mastering-plone/anatomy.rst similarity index 100% rename from mastering_plone/anatomy.rst rename to mastering-plone/anatomy.rst diff --git a/mastering_plone/api.rst b/mastering-plone/api.rst similarity index 100% rename from mastering_plone/api.rst rename to mastering-plone/api.rst diff --git a/mastering_plone/behaviors_1.rst b/mastering-plone/behaviors_1.rst similarity index 100% rename from mastering_plone/behaviors_1.rst rename to mastering-plone/behaviors_1.rst diff --git a/mastering_plone/behaviors_2.rst b/mastering-plone/behaviors_2.rst similarity index 100% rename from mastering_plone/behaviors_2.rst rename to mastering-plone/behaviors_2.rst diff --git a/mastering_plone/buildout_1.rst b/mastering-plone/buildout_1.rst similarity index 100% rename from mastering_plone/buildout_1.rst rename to mastering-plone/buildout_1.rst diff --git a/mastering_plone/case.rst b/mastering-plone/case.rst similarity index 100% rename from mastering_plone/case.rst rename to mastering-plone/case.rst diff --git a/mastering_plone/code.rst b/mastering-plone/code.rst similarity index 100% rename from mastering_plone/code.rst rename to mastering-plone/code.rst diff --git a/mastering_plone/configuring_customizing.rst b/mastering-plone/configuring_customizing.rst similarity index 100% rename from mastering_plone/configuring_customizing.rst rename to mastering-plone/configuring_customizing.rst diff --git a/mastering_plone/custom_search.rst b/mastering-plone/custom_search.rst similarity index 100% rename from mastering_plone/custom_search.rst rename to mastering-plone/custom_search.rst diff --git a/mastering_plone/deployment_code.rst b/mastering-plone/deployment_code.rst similarity index 100% rename from mastering_plone/deployment_code.rst rename to mastering-plone/deployment_code.rst diff --git a/mastering_plone/deployment_sites.rst b/mastering-plone/deployment_sites.rst similarity index 100% rename from mastering_plone/deployment_sites.rst rename to mastering-plone/deployment_sites.rst diff --git a/mastering_plone/development_bucarest.rst b/mastering-plone/development_bucarest.rst similarity index 100% rename from mastering_plone/development_bucarest.rst rename to mastering-plone/development_bucarest.rst diff --git a/mastering_plone/dexterity.rst b/mastering-plone/dexterity.rst similarity index 100% rename from mastering_plone/dexterity.rst rename to mastering-plone/dexterity.rst diff --git a/mastering_plone/dexterity_2.rst b/mastering-plone/dexterity_2.rst similarity index 100% rename from mastering_plone/dexterity_2.rst rename to mastering-plone/dexterity_2.rst diff --git a/mastering_plone/dexterity_3.rst b/mastering-plone/dexterity_3.rst similarity index 100% rename from mastering_plone/dexterity_3.rst rename to mastering-plone/dexterity_3.rst diff --git a/mastering_plone/eggs1.rst b/mastering-plone/eggs1.rst similarity index 100% rename from mastering_plone/eggs1.rst rename to mastering-plone/eggs1.rst diff --git a/mastering_plone/eggs2.rst b/mastering-plone/eggs2.rst similarity index 100% rename from mastering_plone/eggs2.rst rename to mastering-plone/eggs2.rst diff --git a/mastering_plone/embed.rst b/mastering-plone/embed.rst similarity index 100% rename from mastering_plone/embed.rst rename to mastering-plone/embed.rst diff --git a/mastering_plone/events.rst b/mastering-plone/events.rst similarity index 100% rename from mastering_plone/events.rst rename to mastering-plone/events.rst diff --git a/mastering_plone/export_code.rst b/mastering-plone/export_code.rst similarity index 100% rename from mastering_plone/export_code.rst rename to mastering-plone/export_code.rst diff --git a/mastering_plone/extending.rst b/mastering-plone/extending.rst similarity index 100% rename from mastering_plone/extending.rst rename to mastering-plone/extending.rst diff --git a/mastering_plone/features.rst b/mastering-plone/features.rst similarity index 100% rename from mastering_plone/features.rst rename to mastering-plone/features.rst diff --git a/mastering_plone/frontpage.rst b/mastering-plone/frontpage.rst similarity index 100% rename from mastering_plone/frontpage.rst rename to mastering-plone/frontpage.rst diff --git a/mastering_plone/future_of_plone.rst b/mastering-plone/future_of_plone.rst similarity index 100% rename from mastering_plone/future_of_plone.rst rename to mastering-plone/future_of_plone.rst diff --git a/mastering_plone/grok.rst b/mastering-plone/grok.rst similarity index 100% rename from mastering_plone/grok.rst rename to mastering-plone/grok.rst diff --git a/mastering_plone/ide.rst b/mastering-plone/ide.rst similarity index 100% rename from mastering_plone/ide.rst rename to mastering-plone/ide.rst diff --git a/mastering_plone/index.rst b/mastering-plone/index.rst similarity index 100% rename from mastering_plone/index.rst rename to mastering-plone/index.rst diff --git a/mastering_plone/installation.rst b/mastering-plone/installation.rst similarity index 100% rename from mastering_plone/installation.rst rename to mastering-plone/installation.rst diff --git a/mastering_plone/intro.rst b/mastering-plone/intro.rst similarity index 100% rename from mastering_plone/intro.rst rename to mastering-plone/intro.rst diff --git a/mastering_plone/optional.rst b/mastering-plone/optional.rst similarity index 100% rename from mastering_plone/optional.rst rename to mastering-plone/optional.rst diff --git a/mastering_plone/plone5.rst b/mastering-plone/plone5.rst similarity index 100% rename from mastering_plone/plone5.rst rename to mastering-plone/plone5.rst diff --git a/mastering_plone/registry.rst b/mastering-plone/registry.rst similarity index 100% rename from mastering_plone/registry.rst rename to mastering-plone/registry.rst diff --git a/mastering_plone/relations.rst b/mastering-plone/relations.rst similarity index 100% rename from mastering_plone/relations.rst rename to mastering-plone/relations.rst diff --git a/mastering_plone/resources.rst b/mastering-plone/resources.rst similarity index 100% rename from mastering_plone/resources.rst rename to mastering-plone/resources.rst diff --git a/mastering_plone/restapi.rst b/mastering-plone/restapi.rst similarity index 100% rename from mastering_plone/restapi.rst rename to mastering-plone/restapi.rst diff --git a/mastering_plone/reusable.rst b/mastering-plone/reusable.rst similarity index 100% rename from mastering_plone/reusable.rst rename to mastering-plone/reusable.rst diff --git a/mastering_plone/roadmap.rst b/mastering-plone/roadmap.rst similarity index 100% rename from mastering_plone/roadmap.rst rename to mastering-plone/roadmap.rst diff --git a/mastering_plone/testing.rst b/mastering-plone/testing.rst similarity index 100% rename from mastering_plone/testing.rst rename to mastering-plone/testing.rst diff --git a/mastering_plone/theming.rst b/mastering-plone/theming.rst similarity index 100% rename from mastering_plone/theming.rst rename to mastering-plone/theming.rst diff --git a/mastering_plone/thirdparty_behaviors.rst b/mastering-plone/thirdparty_behaviors.rst similarity index 100% rename from mastering_plone/thirdparty_behaviors.rst rename to mastering-plone/thirdparty_behaviors.rst diff --git a/mastering_plone/timing.rst b/mastering-plone/timing.rst similarity index 100% rename from mastering_plone/timing.rst rename to mastering-plone/timing.rst diff --git a/mastering_plone/user_generated_content.rst b/mastering-plone/user_generated_content.rst similarity index 100% rename from mastering_plone/user_generated_content.rst rename to mastering-plone/user_generated_content.rst diff --git a/mastering_plone/viewlets_1.rst b/mastering-plone/viewlets_1.rst similarity index 100% rename from mastering_plone/viewlets_1.rst rename to mastering-plone/viewlets_1.rst diff --git a/mastering_plone/viewlets_2.rst b/mastering-plone/viewlets_2.rst similarity index 100% rename from mastering_plone/viewlets_2.rst rename to mastering-plone/viewlets_2.rst diff --git a/mastering_plone/views_1.rst b/mastering-plone/views_1.rst similarity index 100% rename from mastering_plone/views_1.rst rename to mastering-plone/views_1.rst diff --git a/mastering_plone/views_2.rst b/mastering-plone/views_2.rst similarity index 100% rename from mastering_plone/views_2.rst rename to mastering-plone/views_2.rst diff --git a/mastering_plone/views_3.rst b/mastering-plone/views_3.rst similarity index 100% rename from mastering_plone/views_3.rst rename to mastering-plone/views_3.rst diff --git a/mastering_plone/zpt.rst b/mastering-plone/zpt.rst similarity index 100% rename from mastering_plone/zpt.rst rename to mastering-plone/zpt.rst diff --git a/mastering_plone/zpt_2.rst b/mastering-plone/zpt_2.rst similarity index 100% rename from mastering_plone/zpt_2.rst rename to mastering-plone/zpt_2.rst diff --git a/trainthetrainer/after.rst b/teachers-training/after.rst similarity index 100% rename from trainthetrainer/after.rst rename to teachers-training/after.rst diff --git a/trainthetrainer/before.rst b/teachers-training/before.rst similarity index 100% rename from trainthetrainer/before.rst rename to teachers-training/before.rst diff --git a/trainthetrainer/during.rst b/teachers-training/during.rst similarity index 100% rename from trainthetrainer/during.rst rename to teachers-training/during.rst diff --git a/trainthetrainer/index.rst b/teachers-training/index.rst similarity index 100% rename from trainthetrainer/index.rst rename to teachers-training/index.rst diff --git a/trainthetrainer/theory.rst b/teachers-training/theory.rst similarity index 100% rename from trainthetrainer/theory.rst rename to teachers-training/theory.rst diff --git a/wip.rst b/wip.rst new file mode 100644 index 0000000..6a79f0a --- /dev/null +++ b/wip.rst @@ -0,0 +1,36 @@ +================ +Work In Progress +================ + +Structure +========= + +Naming Convention +----------------- + +Writing is **not** coding ! + +Directories +~~~~~~~~~~~ + +Please use ``-`` and not ``_`` for naming folder + +**Bad**: mastering_plone + +**Good**: mastering-plone + +Underscores are only used for templates like ``_templates`` and for static directories like ``_static``. + +Setup +===== + +- Every training goes into its own directory in the main repository. +- Every training get its own conf.py and own _template and _static directory with its own content. +- Every training should be able to be build on its own without depending on each other +- One main Makefile to build all trainings [example: website] in the /root of the repository. +- Use intersphinx to link to needed parts if we must. [Not preferred as trainings should be 'standalone'] + +Tone Of Voice +============= + +- Should be set according to audience. ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot