From 9855534467c1b3023a5214793c45bc95ab01b3e9 Mon Sep 17 00:00:00 2001
From: Daniel Speicher <daniel.speicher@lakedrops.com>
Date: Sun, 23 Jun 2024 10:42:09 +0200
Subject: [PATCH] Reorganize doc
---
docs/dev_tools/test.md | 17 +++++++++++++----
docs/gitlab/ansible/index.md | 12 ------------
docs/gitlab/composer/index.md | 12 ------------
mkdocs.yml | 2 --
4 files changed, 13 insertions(+), 30 deletions(-)
delete mode 100644 docs/gitlab/ansible/index.md
delete mode 100644 docs/gitlab/composer/index.md
diff --git a/docs/dev_tools/test.md b/docs/dev_tools/test.md
index 67b46d6..65b0930 100644
--- a/docs/dev_tools/test.md
+++ b/docs/dev_tools/test.md
@@ -275,9 +275,21 @@ To take advantage of the Drupal optimized pipelines we make heavy use of the [Gi
Here you find more information of using [ES Lint in a pipeline](https://project.pages.drupalcode.org/gitlab_templates/jobs/eslint/).
+### CSpell
+[CSpell](https://cspell.org/) checks the orthography of your code and comments, which increases your clean code experience.
-### CSpell
+If you want to execute `Cspell` for a module, just do the following:
+
+```cspell
+a test cspellmodule
+```
+
+If you want to analyse a custom module, just do the following:
+
+```cspell
+a test cspellmodule ../custom/<custom_module>
+```
#### Using CSpell in a GitLab pipeline
@@ -286,8 +298,6 @@ To take advantage of the Drupal optimized pipelines we make heavy use of the [Gi
Here you find more information of using [CSpell in a pipeline](https://project.pages.drupalcode.org/gitlab_templates/jobs/cspell/).
-
-
## Unit/Kernel/Functional Testing
To execute the tests, you can use a single command:
@@ -344,7 +354,6 @@ To take advantage of the Drupal optimized pipelines we make heavy use of the [Gi
Here you find more information of using [PHPUnit in a pipeline](https://project.pages.drupalcode.org/gitlab_templates/jobs/phpunit/).
-
### Code Coverage
First, activate the coverage option:
diff --git a/docs/gitlab/ansible/index.md b/docs/gitlab/ansible/index.md
deleted file mode 100644
index e11db3d..0000000
--- a/docs/gitlab/ansible/index.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: GitLab Ansible
-repo: https://gitlab.lakedrops.com/gitlab-ci-cd/ansible
-issues: https://gitlab.lakedrops.com/gitlab-ci-cd/ansible/-/issues
-tags:
-- gitlab
-- ci/cd
-- ansible
----
-# Ansible
-
-Describe the templates for Ansible tasks in GitLab CI.
diff --git a/docs/gitlab/composer/index.md b/docs/gitlab/composer/index.md
deleted file mode 100644
index dc22fbd..0000000
--- a/docs/gitlab/composer/index.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: GitLab Composer
-repo: https://gitlab.lakedrops.com/gitlab-ci-cd/composer
-issues: https://gitlab.lakedrops.com/gitlab-ci-cd/composer/-/issues
-tags:
-- gitlab
-- ci/cd
-- composer
----
-# Composer Packages
-
-Template for creating and updating composer packages in Gitlab.
diff --git a/mkdocs.yml b/mkdocs.yml
index 451f438..9a7df46 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -265,8 +265,6 @@ nav:
- Zammad: ansible/roles/zammad/index.md
- GitLab:
- gitlab/index.md
- - Ansible: gitlab/ansible/index.md
- - Composer: gitlab/composer/index.md
- Drupal: gitlab/drupal/index.md
- DevOps:
- ALM:
--
GitLab