Move templates to a /templates folder

[ericof]

Requires Cookieplone #88 to be merged and released.

Current situation

• Every template is at the root of the cookieplone-templates repository
• Soon we will start having issues when new templates are added to the repository
  • A docs folder at the root of the repository is a template or the real documentation?
  • A news folder at the root of the repository is a template or something else?
• Organization in folders and sub folders will help us maintain the templates in the long run

Proposed organization

Have a /templates/ top level folder with a sub folder structure similar to:

• projects
  • monorepo
  • classic
• sub
  • cache
  • settings
• add-ons
  • monorepo
  • backend
  • frontend
• distributions
  • monorepo
• devops
• ...

Move all tests to the /tests top-level folder:

• Organize tests in sub-folders similar to the code structure
• Allow reuse of fixtures
  • cutter-result would be defined once for all templates

Impacts

• For the end user:
  • Nothing changes
• For template developers:
  • Move tests from the template folder to the top-level /tests folder
  • Usage of sub-templates should always mention the full path to the template

   TEMPLATES_FOLDER = "templates"
    generator.generate_subtemplate(
        f"{TEMPLATES_FOLDER}/add-ons/frontend",
        output_dir,
        "frontend",
        context,
        FRONTEND_ADDON_REMOVE,
    )

[stevepiercy]

I'm not clear. Will it be:

/templates/
/projects/

or

/templates/projects/

What are the reasons to do this?

What are the impacts, especially for documentation?

[ericof]

@stevepiercy I've updated the description, do you thing this is addresses your questions?

[stevepiercy]

@ericof partly. Let me try to rephrase them.

1. I'm still not clear on the directory structure. Will it be the first list or second?

---

• templates
• projects
  • monorepo
  • classic
• sub
  • cache
  • settings
• add-ons
  • monorepo
  • backend
  • frontend
• distributions
  • monorepo
• devops

---

• templates
  • projects
    • monorepo
    • classic
  • sub
    • cache
    • settings
  • add-ons
    • monorepo
    • backend
    • frontend
  • distributions
    • monorepo
  • devops

---

2. Where would news or docs go?

3. It sounds like testing will benefit by being able to reuse fixtures, but I'm not clear on other benefits. For example, what is a sub-template, and what can I do with one?

4. Will we need to update Plone 6 Documentation, and if so, where? It sounds like no.

[ericof]

@stevepiercy, sorry for misunderstanding your question.

1. and 2, The proposed structure (Already implemented on this branch)

• .github
• docs
• news
• templates
  • projects
    • monorepo
    • classic
  • sub
    • cache
    • settings
  • add-ons
    • monorepo
    • backend
    • frontend
  • distributions
    • monorepo
    • devops
• tests
• README.md

3. Testing and Reuse
   3.1. Testing: Right now, every template has its own tests folder and, as they were created in different moments, they are not all at the same maturity level. Also, most of them started by being copied from a previous template, and we do benefit from sharing the same pytest fixtures, and that also reduces the amount of time needed to run all tests.
   3.2. Sub templates: We implemented them at the earlier stages of cookieplone-templates (To be fair, reusing a template was one of the main reasons to implement Cookieplone). Sub templates are not accessed directly by the end user, but they implement parts of code that could be shared among the public templates. i.e. The cache support we have on the project template is implemented like that (as devops should).

4. No need to update the existing documentation. But I do plan to write a "developer's guide" for cookieplone-templates, let's see if I can deliver that after the Bucharest sprint is over.