Ensure references to the repository url are consistent across all templates (#223)

* Ensure references to the repository url are consistent across all templates (Fixes #221)

* Apply suggestions from code review

Co-authored-by: Steve Piercy <[email protected]>

* Apply suggestions from code review

Co-authored-by: Steve Piercy <[email protected]>

* Apply suggestions from code review

Co-authored-by: Steve Piercy <[email protected]>

* Reorder instructions for Volto installation

* Properly indent code blocks to belong to their list items

* GitHub UI wouldn't allow the suggestion to be committed, so manual it is

* Fix tests

* Apply suggestions from code review

Co-authored-by: Steve Piercy <[email protected]>

* Update templates/sub/project_settings/{{ cookiecutter.__folder_name }}/backend/README.md

Co-authored-by: Steve Piercy <[email protected]>

* Update templates/sub/project_settings/cookiecutter.json

Co-authored-by: Steve Piercy <[email protected]>

---------

Co-authored-by: Steve Piercy <[email protected]>

Author: ericof

news/221.bugfix

@@ -0,0 +1 @@
+Standardize usage of the repository URLs in templates. @ericof

pyproject.toml

@@ -5,7 +5,7 @@ description = "Collection of templates for Plone integrators to use through Cook
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "cookieplone>=0.9.6",
+    "cookieplone>=0.9.7",
     "gitpython>=3.1.43",
     "pytest>=8.3.5",
     "pytest-cookies>=0.7.0",

templates/add-ons/backend/cookiecutter.json

@@ -12,6 +12,7 @@
   "initialize_documentation": ["1", "0"],
   "__project_slug": "{{ cookiecutter.python_package_name }}",
   "__repository_url": "https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.__project_slug }}",
+  "__repository_git": "[email protected]:{{ cookiecutter.github_organization }}/{{ cookiecutter.__project_slug }}",
   "__feature_headless": "{{ cookiecutter.feature_headless }}",
   "__feature_distribution": "0",
   "__package_path": "{{ cookiecutter.python_package_name | package_path }}",

templates/add-ons/backend/hooks/pre_gen_project.py

@@ -0,0 +1,17 @@
+"""Pre generation hook."""
+
+from collections import OrderedDict
+from pathlib import Path
+
+output_path = Path().resolve()
+
+context: OrderedDict = {{cookiecutter}}
+
+
+def main():
+    """Validate context."""
+    pass
+
+
+if __name__ == "__main__":
+    main()

templates/add-ons/backend/{{ cookiecutter.__folder_name }}/README.md

@@ -20,7 +20,36 @@ And to create the Plone site:
 make create-site
 ```
 
-## Add features using `plonecli` or `bobtemplates.plone`
+## Contribute
+
+- [Issue tracker]({{ cookiecutter.__repository_url }}/issues)
+- [Source code]({{ cookiecutter.__repository_url }}/)
+
+### Prerequisites ✅
+
+-   An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.
+-   [uv](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)
+-   [Make](https://6.docs.plone.org/install/create-project-cookieplone.html#make)
+-   [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)
+-   [Docker](https://docs.docker.com/get-started/get-docker/) (optional)
+
+### Installation 🔧
+
+1.  Clone this repository, then change your working directory.
+
+    ```shell
+    git clone {{ cookiecutter.__repository_git }}.git
+    cd {{ cookiecutter.__project_slug }}
+    ```
+
+2.  Install this code base.
+
+    ```shell
+    make install
+    ```
+
+
+### Add features using `plonecli` or `bobtemplates.plone`
 
 This package provides markers as strings (`<!-- extra stuff goes here -->`) that are compatible with [`plonecli`](https://github.com/plone/plonecli) and [`bobtemplates.plone`](https://github.com/plone/bobtemplates.plone).
 These markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from `plonecli`.
@@ -48,11 +77,6 @@ You can check the list of available subtemplates in the [`bobtemplates.plone` `R
 See also the documentation of [Mockup and Patternslib](https://6.docs.plone.org/classic-ui/mockup.html) for how to build the UI toolkit for Classic UI.
 ```
 
-## Contribute
-
-- [Issue Tracker]({{ cookiecutter.__repository_url }}/issues)
-- [Source Code]({{ cookiecutter.__repository_url }}/)
-
 ## License
 
 The project is licensed under GPLv2.

templates/add-ons/backend/{{ cookiecutter.__folder_name }}/src/packagename/locales/__main__.py

@@ -1,11 +1,9 @@
 """Update locales."""
 
-from pathlib import Path
-
 import logging
 import re
 import subprocess
-
+from pathlib import Path
 
 logger = logging.getLogger("i18n")
 logger.setLevel(logging.DEBUG)
@@ -17,7 +15,7 @@
 target_path = locale_path.parent.resolve()
 domains = [path.name[:-4] for path in locale_path.glob("*.pot")]
 
-i18ndude = "uv run i18ndude"
+i18ndude = "uvx i18ndude"
 
 # ignore node_modules files resulting in errors
 excludes = '"*.html *json-schema*.xml"'

templates/add-ons/documentation_starter/cookiecutter.json

@@ -5,12 +5,12 @@
   "email": "[email protected]",
   "github_organization": "collective",
   "initialize_git": ["1", "0"],
-  "plone_version": "6.0",
   "__folder_name": "{{ cookiecutter.github_organization|lower }}.{{ cookiecutter.title|replace(' ', '')|replace('-', '_')|replace('.', '')|lower }}",
   "__normalized_package_name": "{{ cookiecutter.title|replace(' ', '')|replace('-', '_')|replace('.', '')|lower }}",
+  "__project_slug": "{{ cookiecutter.__normalized_package_name }}",
+  "__repository_url": "https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.__project_slug }}",
+  "__repository_git": "[email protected]:{{ cookiecutter.github_organization }}/{{ cookiecutter.__project_slug }}",
   "__year": "{% now 'local', '%Y' %}",
-  "__profile_language": "en",
-  "__version_package": "1.0.0a0",
   "__generator_date_long": "{% now 'utc', '%Y-%m-%d %H:%M:%S' %}",
   "__generator_signature": "This was generated by the [cookieplone-templates documentation_starter template](https://github.com/plone/cookieplone-templates/tree/main/documentation_starter) on {{ cookiecutter.__generator_date_long }}",
   "__documentation_starter_format": "1",

templates/add-ons/documentation_starter/hooks/pre_gen_project.py

@@ -0,0 +1,17 @@
+"""Pre generation hook."""
+
+from collections import OrderedDict
+from pathlib import Path
+
+output_path = Path().resolve()
+
+context: OrderedDict = {{cookiecutter}}
+
+
+def main():
+    """Validate context."""
+    pass
+
+
+if __name__ == "__main__":
+    main()