From 7d1332a0fc7c1fa6aca3ac9dae55fee415b72bc8 Mon Sep 17 00:00:00 2001 From: sven Date: Thu, 16 May 2024 08:59:52 +0200 Subject: [PATCH 1/2] enhance markdown and wording --- README.md | 42 ++++++++++++++++++++++++---------------- backend_addon/README.md | 15 +++++++------- frontend_addon/README.md | 4 ++-- 3 files changed, 35 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 0dd3640..d2cd1b5 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,52 @@ +

+ Plone Logo +

+ +

+ Cookieplone Templates +

+ +
+ ![GitHub](https://img.shields.io/github/license/plone/cookiecutter-plone) [![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) -# Cookieplone Templates +
-Powered by [Cookieplone](https://github.com/plone/cookieplone), this is a collection of templates intended to be used by Plone integrators. +## About -## Getting Started 🏁 +Powered by [Cookieplone](https://github.com/plone/cookieplone "Link to the GitHub repository of Cookieplone" ), a collection of templates intended to be used by Plone integrators. -### Prerequisites +## Prerequisites -- **pipx**: A handy tool for installing and running Python applications. +- **[pipx](https://pipx.pypa.io/ "Link to the website of pipx")**: A tool for installing and running Python applications. -### Installation Guide 🛠️ +## Installation 💾 -**pipx** +Install `pipx` with the following command: ```shell pip install pipx ``` -### Choose a template 🎉 +## Choose a template 🛠️ -First run the command: +Run the `cookieplone` command to select a template: ```shell pipx run cookieplone ``` -And choose a template: -``` - [1/1] Select a template - 1 - Backend Add-on for Plone - 2 - Frontend Add-on +```text +[1/1] Select a template + 1 - Backend Add-on for Plone + 2 - Frontend Add-on ``` | Template | Description | | | --------- | --------- | --------- | -| `Backend Add-on for Plone` | Creates a new Python package to be used with Plone | [Read More](./backend_addon/README.md) | -| `Frontend Add-on for Plone` | Creates a new Node package to be used with Volto | [Read More](./frontend_addon/README.md) | - +| `Backend Add-on for Plone` | Create a new Python package to be used with Plone. | [Read More](./backend_addon/README.md) | +| `Frontend Add-on for Plone` | Create a new Node package to be used with Volto. | [Read More](./frontend_addon/README.md) | ## License 📜 diff --git a/backend_addon/README.md b/backend_addon/README.md index 61dced2..f492194 100644 --- a/backend_addon/README.md +++ b/backend_addon/README.md @@ -5,7 +5,7 @@ # Cookieplone Backend Add-on -Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter](https://github.com/cookiecutter/cookiecutter), [Cookieplone Backend Add-on](https://github.com/plone/cookieplone-templates/backend_addon) is intended to be used by Plone developers to create new addon packages. +Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter](https://github.com/cookiecutter/cookiecutter), [Cookieplone Backend Add-on](https://github.com/plone/cookieplone-templates/backend_addon) is intended to be used by Plone developers to create new add-on packages. ## Getting Started 🏁 @@ -20,30 +20,30 @@ Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter ```shell pip install pipx ``` -### Generate Your Plone Addon 🎉 + +### Generate Your Plone Add-on 🎉 ```shell pipx run cookieplone backend_addon ``` - ## Project Generation Options These are all the template options that will be prompted by the [Cookiecutter CLI](https://github.com/cookiecutter/cookiecutter) before generating your project. | Option | Description | Example | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| `title` | Your addon's human-readable name, capitals and spaces allowed. | **Plone Blog** | -| `description` | Describes your addon and gets used in places like ``README.md`` and such. | **Create awesome blogs with Plone.** | +| `title` | Your add-on's human-readable name, capitals and spaces allowed. | **Plone Blog** | +| `description` | Describes your add-on and gets used in places like ``README.md`` and such. | **Create awesome blogs with Plone.** | | `author` | This is you! The value goes into places like ``LICENSE``, ``setup.py`` and such. | **Our Company** | | `email` | The email address you want to identify yourself in the project. | **email@example.com** | | `github_organization` | Used for GitHub and Docker repositories. | **collective** | | `python_package_name` | Name of the Python package used to configure your project. It needs to be Python-importable, so no dashes, spaces or special characters are allowed. | **collective.blog** | - ## Code Quality Assurance 🧐 -Your package comes equipped with linters to ensure code quality. Run the following to automatically format your code: +Your package comes equipped with linters to ensure code quality. +Run the following to automatically format your code: ```shell make format @@ -56,6 +56,7 @@ Generate translation files with ease: ```shell make i18n ``` + ## License 📜 This project is licensed under the [MIT License](/LICENSE). diff --git a/frontend_addon/README.md b/frontend_addon/README.md index 46448f3..302c02b 100644 --- a/frontend_addon/README.md +++ b/frontend_addon/README.md @@ -20,13 +20,13 @@ Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter ```shell pip install pipx ``` + ### Generate Your Plone Add-on 🎉 ```shell pipx run cookieplone frontend_addon ``` - ## Project Generation Options These are all the template options that will be prompted by the [Cookiecutter CLI](https://github.com/cookiecutter/cookiecutter) before generating your project. @@ -42,7 +42,6 @@ These are all the template options that will be prompted by the [Cookiecutter CL | `npm_package_name` | Name of the Node package, including the organization (if any). | **@plone-collective/volto-weather-block** | | `volto_version` | Volto version to be used. | **18.0.0-alpha.31** | - ## Code Quality Assurance 🧐 Your package comes equipped with linters to ensure code quality. Run the following to automatically format your code: @@ -58,6 +57,7 @@ Generate translation files with ease: ```shell make i18n ``` + ## License 📜 This project is licensed under the [MIT License](/LICENSE). From 4a2ad5200c780cd9dd9cddab1c7fceeffdfc4c69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Andrei?= Date: Thu, 16 May 2024 04:40:49 -0400 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Steve Piercy --- README.md | 6 +++--- backend_addon/README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d2cd1b5..b0aeb82 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,11 @@ ## About -Powered by [Cookieplone](https://github.com/plone/cookieplone "Link to the GitHub repository of Cookieplone" ), a collection of templates intended to be used by Plone integrators. +Powered by [Cookieplone](https://github.com/plone/cookieplone "Link to the GitHub repository of Cookieplone"), this project is a collection of templates intended to be used by Plone integrators. ## Prerequisites -- **[pipx](https://pipx.pypa.io/ "Link to the website of pipx")**: A tool for installing and running Python applications. +- **[pipx](https://pipx.pypa.io/stable/ "Link to the website of pipx")**: A tool for installing and running Python applications. ## Installation 💾 @@ -31,7 +31,7 @@ pip install pipx ## Choose a template 🛠️ -Run the `cookieplone` command to select a template: +Select a template with the following command: ```shell pipx run cookieplone diff --git a/backend_addon/README.md b/backend_addon/README.md index f492194..2a17484 100644 --- a/backend_addon/README.md +++ b/backend_addon/README.md @@ -43,7 +43,7 @@ These are all the template options that will be prompted by the [Cookiecutter CL ## Code Quality Assurance 🧐 Your package comes equipped with linters to ensure code quality. -Run the following to automatically format your code: +Run the following command to automatically format your code: ```shell make format