[#1225] Moved consumer part of README to own file. (#1226)

drevops · Mar 14, 2024 · 351f6d0 · 351f6d0
1 parent ad5531c
commit 351f6d0
Show file tree

Hide file tree

Showing 4 changed files with 112 additions and 131 deletions.
diff --git a/.drevops/docs/content/introduction/features.md b/.drevops/docs/content/introduction/features.md
@@ -5,7 +5,7 @@ search:
 
 # Features
 
-The following list includes ✅ completed  and 💡 upcoming features.
+The following list includes ✅ completed  and 🚧 upcoming features.
 
 * 💧 Drupal
     * ✅ Based on [drupal-composer/drupal-project](https://github.com/drupal-composer/drupal-project)
@@ -30,17 +30,17 @@ The following list includes ✅ completed  and 💡 upcoming features.
 * 🏨 Hosting
     * ✅ [Acquia](https://www.acquia.com/)
     * ✅ [Lagoon](https://github.com/uselagoon/lagoon)
-    * 💡 [Pantheon](https://pantheon.io/)
-    * 💡 [Platform.sh](https://platform.sh/)
+    * 🚧 [Pantheon](https://pantheon.io/)
+    * 🚧 [Platform.sh](https://platform.sh/)
 * 💻 Local development
     * ✅ [Docker Compose](https://docs.docker.com/compose/) + [Ahoy](https://github.com/ahoy-cli/ahoy)
-    * 💡 [Lando](https://lando.dev/)
-    * 💡 [DDEV](https://ddev.readthedocs.io/)
+    * 🚧 [Lando](https://lando.dev/)
+    * 🚧 [DDEV](https://ddev.readthedocs.io/)
 * 🏗️ CI/CD
     * ✅ [Circle CI](https://circleci.com/)
-    * 💡 [GitHub Actions](https://github.com/features/actions)
-    * 💡 [GitLab CI](https://docs.gitlab.com/ee/ci/)
-    * 💡 [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/)
+    * 🚧 [GitHub Actions](https://github.com/features/actions)
+    * 🚧 [GitLab CI](https://docs.gitlab.com/ee/ci/)
+    * 🚧 [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/)
 * 🛠️ Tooling
     * ✅ [Behat](https://docs.behat.org/en/latest/) + [Drupal extension](https://github.com/jhedstrom/drupalextension) + [Behat Screenshot](https://github.com/drevops/behat-screenshot) + [Behat steps](https://github.com/drevops/behat-steps)
     * ✅ [ESLint](https://eslint.org/)
@@ -52,7 +52,7 @@ The following list includes ✅ completed  and 💡 upcoming features.
     * ✅ [SASS Lint](https://github.com/sasstools/sass-lint)
     * ✅ [SASS](https://sass-lang.com/)
     * ✅ [Twig CS Fixer](https://github.com/VincentLanglet/Twig-CS-Fixer)
-    * 💡 [Pa11y](https://pa11y.org/)
+    * 🚧 [Pa11y](https://pa11y.org/)
 * ⚙️ Workflow
     * ✅ Database from FTP, CURL, Docker image, hosting provider
     * ✅ [Pull request template](../../../../.github/PULL_REQUEST_TEMPLATE.md)
@@ -74,7 +74,7 @@ The following list includes ✅ completed  and 💡 upcoming features.
     * ✅ Integration test coverage for deployments
     * ✅ DrevOps updates
     * ✅ [Basic installer](https://install.drevops.com/)
-    * 💡 Advanced installer CLI UI
-    * 💡 Advances installer Web UI
-    * 💡 Automated project setup
-    * 💡 Project dashboard
+    * 🚧 Advanced installer CLI UI
+    * 🚧 Advances installer Web UI
+    * 🚧 Automated project setup
+    * 🚧 Project dashboard
diff --git a/.drevops/tests/bats/_helper.bash b/.drevops/tests/bats/_helper.bash
@@ -254,6 +254,8 @@ assert_files_present_common() {
   # Assert that DrevOps version was replaced.
   assert_file_contains "README.md" "badge/DrevOps-${DREVOPS_VERSION:-develop}-blue.svg"
   assert_file_contains "README.md" "https://github.com/drevops/drevops/tree/${DREVOPS_VERSION:-develop}"
+  assert_file_not_contains "README.md" "The following list includes"
+  assert_file_not_exists "README.dist.md"
 
   assert_files_present_drupal "${dir}" "${suffix}" "${suffix_abbreviated}" "${suffix_abbreviated_camel_cased}" "${suffix_camel_cased}" "${webroot}"
 

diff --git a/README.dist.md b/README.dist.md
@@ -0,0 +1,71 @@
+# YOURSITE
+Drupal 10 implementation of YOURSITE for YOURORG
+
+[![CircleCI](https://circleci.com/gh/your_org/your_site.svg?style=shield)](https://circleci.com/gh/your_org/your_site)
+![Drupal 10](https://img.shields.io/badge/Drupal-10-blue.svg)
+[![codecov](https://codecov.io/gh/your_org/your_site/graph/badge.svg)](https://codecov.io/gh/your_org/your_site)
+
+[//]: # (#;< RENOVATEBOT)
+
+[![RenovateBot](https://img.shields.io/badge/RenovateBot-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com)
+
+[//]: # (#;> RENOVATEBOT)
+
+[//]: # (DO NOT REMOVE THE BADGE BELOW. IT IS USED BY DREVOPS TO TRACK INTEGRATION)
+
+[![DrevOps](https://img.shields.io/badge/DrevOps-DREVOPS_VERSION_URLENCODED-blue.svg)](https://github.com/drevops/drevops/tree/DREVOPS_VERSION)
+
+## Onboarding to DrevOps
+Use [Onboarding checklist](docs/onboarding.md) to track the project onboarding
+to DrevOps progress. Remove this section once onboarding is finished.
+
+## Local environment setup
+
+- Make sure that you have latest versions of all required software installed:
+  - [Docker](https://www.docker.com/)
+  - [Pygmy](https://github.com/pygmystack/pygmy)
+  - [Ahoy](https://github.com/ahoy-cli/ahoy)
+- Make sure that all local web development services are shut down (Apache/Nginx, Mysql, MAMP etc).
+- Checkout project repository (in one of the [supported Docker directories](https://docs.docker.com/docker-for-mac/osxfs/#access-control)).
+
+[//]: # (#;< ACQUIA)
+
+- Authenticate with Acquia Cloud API
+  1. Create your Acquia Cloud API token:<br/>
+     Acquia Cloud UI -> Account -> API tokens -> Create Token
+  2. Copy `.env.local.default` to `.env.local`.
+  3. Populate `$DREVOPS_ACQUIA_KEY` and `$DREVOPS_ACQUIA_SECRET` environment
+     variables in `.env.local` file with values generated in the step above.
+
+[//]: # (#;> ACQUIA)
+
+[//]: # (#;< LAGOON)
+
+- Authenticate with Lagoon
+  1. Create an SSH key and add it to your account in the [Lagoon Dashboard](https://ui-lagoon-master.ch.amazee.io/).
+  2. Copy `.env.local.default` to `.env.local`.
+  3. Update `$DREVOPS_DB_DOWNLOAD_SSH_FILE` environment variable in `.env.local` file
+     with the path to the SSH key.
+
+[//]: # (#;> LAGOON)
+
+
+[//]: # (#;< !PROVISION_USE_PROFILE)
+
+- `ahoy download-db`
+
+[//]: # (#;> !PROVISION_USE_PROFILE)
+- `pygmy up`
+- `ahoy build`
+
+### Apple M1 adjustments
+
+Copy `docker-compose.override.default.yml` to `docker-compose.override.yml`.
+
+## Project documentation
+
+- [FAQs](docs/faqs.md)
+- [Testing](docs/testing.md)
+- [CI](docs/ci.md)
+- [Releasing](docs/releasing.md)
+- [Deployment](docs/deployment.md)
diff --git a/README.md b/README.md
@@ -1,6 +1,3 @@
-[//]: # (#;< DREVOPS_DEV)
-<table align="center"><tr><td>
-
 <div align="center">
 	<img width="400" src="https://user-images.githubusercontent.com/378794/228488082-814a8ddc-e749-4031-874c-ef545ac00cec.png" alt="DrevOps Logo" />
 </div>
@@ -9,20 +6,19 @@
 <h4 align="center"><em>Onboarding in minutes, not hours or days!</em></h4>
 
 <div align="center">
-
-[![codecov](https://codecov.io/gh/drevops/drevops/graph/badge.svg?token=YDTAEWWT5H)](https://codecov.io/gh/drevops/drevops)
-![GitHub release (latest by date)](https://img.shields.io/github/v/release/drevops/drevops)
-![Drupal 10](https://img.shields.io/badge/Drupal-10-blue.svg)
-![LICENSE](https://img.shields.io/github/license/drevops/drevops)
-[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=%F0%9F%92%A7%2B%20%F0%9F%90%B3%20%2B%20%E2%9C%93%E2%9C%93%E2%9C%93%20%2B%20%F0%9F%A4%96%20%3D%20DrevOps%20-%20%20Build%2C%20Test%2C%20Deploy%20scripts%20for%20Drupal%20using%20Docker%20and%20CI%2FCD&amp;url=https://www.drevops.com&amp;via=drev_ops&amp;hashtags=drupal,devops,workflow,composer,template,kickstart,ci,test,build)
 
 [![Test](https://github.com/drevops/drevops/actions/workflows/drevops-test-common.yml/badge.svg)](https://github.com/drevops/drevops/actions/workflows/drevops-test-common.yml)
 [![Test docs](https://github.com/drevops/drevops/actions/workflows/drevops-test-docs.yml/badge.svg)](https://github.com/drevops/drevops/actions/workflows/drevops-test-docs.yml)
 [![CircleCI](https://circleci.com/gh/drevops/drevops.svg?style=shield)](https://circleci.com/gh/drevops/drevops)
+[![codecov](https://codecov.io/gh/drevops/drevops/graph/badge.svg?token=YDTAEWWT5H)](https://codecov.io/gh/drevops/drevops)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/drevops/drevops)
+![LICENSE](https://img.shields.io/github/license/drevops/drevops)
 
-</div>
+![Drupal 10](https://img.shields.io/badge/Drupal-10-blue.svg)
+
+[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=%F0%9F%92%A7%2B%20%F0%9F%90%B3%20%2B%20%E2%9C%93%E2%9C%93%E2%9C%93%20%2B%20%F0%9F%A4%96%20%3D%20DrevOps%20-%20%20Build%2C%20Test%2C%20Deploy%20scripts%20for%20Drupal%20using%20Docker%20and%20CI%2FCD&amp;url=https://www.drevops.com&amp;via=drev_ops&amp;hashtags=drupal,devops,workflow,composer,template,kickstart,ci,test,build)
 
-</td></tr><tr><td>
+</div>
 
 ## Purpose
 
@@ -38,29 +34,25 @@ Use **tested** Drupal project template with DevOps integrations for CI and hosti
 2. DrevOps integrates the latest project template release into your codebase.
 3. You choose which changes to commit.
 
-</td></tr><tr><td>
-
 ## Installation
 
-`curl -SsL https://install.drevops.com > install.php && php install.php; rm -r install.php`
-
-</td></tr><tr><td>
+```bash
+curl -SsL https://install.drevops.com > install.php
+php install.php
+rm -r install.php
+```
 
 ## Documentation
 
 https://docs.drevops.com
 
-<br/>
-
-</td></tr><tr><td>
-
 ## Features
 
 <div align="center">
   <img  alt="diagram-shortest" src="https://github.com/drevops/drevops/assets/378794/68e7553b-6c29-437a-8a30-45e9d746180a">
 </div>
 
-The following list includes ✅ completed and 💡 upcoming features.
+The following list includes ✅ completed and 🚧 upcoming features.
 
 * 💧 Drupal
   * ✅ Based on [drupal-composer/drupal-project](https://github.com/drupal-composer/drupal-project)
@@ -85,17 +77,17 @@ The following list includes ✅ completed and 💡 upcoming features.
 * 🏨 Hosting
   * ✅ [Acquia](https://www.acquia.com/)
   * ✅ [Lagoon](https://github.com/uselagoon/lagoon)
-  * 💡 [Pantheon](https://pantheon.io/)
-  * 💡 [Platform.sh](https://platform.sh/)
+  * 🚧 [Pantheon](https://pantheon.io/)
+  * 🚧 [Platform.sh](https://platform.sh/)
 * 💻 Local development
   * ✅ [Docker Compose](https://docs.docker.com/compose/) + [Ahoy](https://github.com/ahoy-cli/ahoy)
-  * 💡 [Lando](https://lando.dev/)
-  * 💡 [DDEV](https://ddev.readthedocs.io/)
+  * 🚧 [Lando](https://lando.dev/)
+  * 🚧 [DDEV](https://ddev.readthedocs.io/)
 * 🏗️ CI/CD
   * ✅ [Circle CI](https://circleci.com/)
-  * 💡 [GitHub Actions](https://github.com/features/actions)
-  * 💡 [GitLab CI](https://docs.gitlab.com/ee/ci/)
-  * 💡 [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/)
+  * 🚧 [GitHub Actions](https://github.com/features/actions)
+  * 🚧 [GitLab CI](https://docs.gitlab.com/ee/ci/)
+  * 🚧 [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/)
 * 🛠️ Tooling
   * ✅ [Behat](https://docs.behat.org/en/latest/) + [Drupal extension](https://github.com/jhedstrom/drupalextension) + [Behat Screenshot](https://github.com/drevops/behat-screenshot) + [Behat steps](https://github.com/drevops/behat-steps)
   * ✅ [ESLint](https://eslint.org/)
@@ -107,7 +99,7 @@ The following list includes ✅ completed and 💡 upcoming features.
   * ✅ [SASS Lint](https://github.com/sasstools/sass-lint)
   * ✅ [SASS](https://sass-lang.com/)
   * ✅ [Twig-CS-Fixer](https://github.com/VincentLanglet/Twig-CS-Fixer)
-  * 💡 [Pa11y](https://pa11y.org/)
+  * 🚧 [Pa11y](https://pa11y.org/)
 * ⚙️ Workflow
   * ✅ Database from FTP, CURL, Docker image, hosting provider
   * ✅ [Pull request template](.github/PULL_REQUEST_TEMPLATE.md)
@@ -120,7 +112,7 @@ The following list includes ✅ completed and 💡 upcoming features.
   * ✅ Deployment notification to New Relic
   * ✅ Automated dependencies updates ([Renovate](https://www.mend.io/renovate/))
 * 📖 Documentation
-  * ✅ Your project [README.md](README.md)
+  * ✅ Your project [README.md](README.dist.md)
   * ✅ Your [project documentation](docs)
   * ✅ [DrevOps documentation](https://docs.drevops.com/)
 * 🧪 DrevOps
@@ -129,91 +121,7 @@ The following list includes ✅ completed and 💡 upcoming features.
   * ✅ Integration test coverage for deployments
   * ✅ DrevOps updates
   * ✅ [Basic installer](https://install.drevops.com/)
-  * 💡 Advanced installer CLI UI
-  * 💡 Advances installer Web UI
-  * 💡 Automated project setup
-  * 💡 Project dashboard
-
-<br/>
-
-</td></tr>
-<tr><td>
-
-**Below is a content of the <code>README.md</code> file that will be added to your project.**
-
-**This table will be removed during installation.**
-
-</td></tr></table>
-<br/>
-
-[//]: # (#;> DREVOPS_DEV)
-# YOURSITE
-Drupal 10 implementation of YOURSITE for YOURORG
-
-[![CircleCI](https://circleci.com/gh/your_org/your_site.svg?style=shield)](https://circleci.com/gh/your_org/your_site)
-![Drupal 10](https://img.shields.io/badge/Drupal-10-blue.svg)
-[![codecov](https://codecov.io/gh/your_org/your_site/graph/badge.svg)](https://codecov.io/gh/your_org/your_site)
-
-[//]: # (#;< RENOVATEBOT)
-
-[![RenovateBot](https://img.shields.io/badge/RenovateBot-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com)
-
-[//]: # (#;> RENOVATEBOT)
-
-[//]: # (DO NOT REMOVE THE BADGE BELOW. IT IS USED BY DREVOPS TO TRACK INTEGRATION)
-
-[![DrevOps](https://img.shields.io/badge/DrevOps-DREVOPS_VERSION_URLENCODED-blue.svg)](https://github.com/drevops/drevops/tree/DREVOPS_VERSION)
-
-[//]: # (Remove the section below once onboarding is finished)
-## Onboarding
-Use [Onboarding checklist](docs/onboarding.md) to track the project onboarding progress.
-
-## Local environment setup
-- Make sure that you have latest versions of all required software installed:
-  - [Docker](https://www.docker.com/)
-  - [Pygmy](https://github.com/pygmystack/pygmy)
-  - [Ahoy](https://github.com/ahoy-cli/ahoy)
-- Make sure that all local web development services are shut down (Apache/Nginx, Mysql, MAMP etc).
-- Checkout project repository (in one of the [supported Docker directories](https://docs.docker.com/docker-for-mac/osxfs/#access-control)).
-
-[//]: # (#;< ACQUIA)
-
-- Authenticate with Acquia Cloud API
-  1. Create your Acquia Cloud API token:<br/>
-     Acquia Cloud UI -> Account -> API tokens -> Create Token
-  2. Copy `.env.local.default` to `.env.local`.
-  3. Populate `$DREVOPS_ACQUIA_KEY` and `$DREVOPS_ACQUIA_SECRET` environment
-     variables in `.env.local` file with values generated in the step above.
-
-[//]: # (#;> ACQUIA)
-
-[//]: # (#;< LAGOON)
-
-- Authenticate with Lagoon
-  1. Create an SSH key and add it to your account in the [Lagoon Dashboard](https://ui-lagoon-master.ch.amazee.io/).
-  2. Copy `.env.local.default` to `.env.local`.
-  3. Update `$DREVOPS_DB_DOWNLOAD_SSH_FILE` environment variable in `.env.local` file
-     with the path to the SSH key.
-
-[//]: # (#;> LAGOON)
-
-
-[//]: # (#;< !PROVISION_USE_PROFILE)
-
-- `ahoy download-db`
-
-[//]: # (#;> !PROVISION_USE_PROFILE)
-- `pygmy up`
-- `ahoy build`
-
-### Apple M1 adjustments
-
-Copy `docker-compose.override.default.yml` to `docker-compose.override.yml`.
-
-## Project documentation
-
-- [FAQs](docs/faqs.md)
-- [Testing](docs/testing.md)
-- [CI](docs/ci.md)
-- [Releasing](docs/releasing.md)
-- [Deployment](docs/deployment.md)
+  * 🚧 Advanced installer CLI UI
+  * 🚧 Advances installer Web UI
+  * 🚧 Automated project setup
+  * 🚧 Project dashboard