[#459] DOCS: Use hyphen for file tag separator

Replace document tag separator to hyphen Re-arrange badges in README.md Update badges' links to courses Remove badge with book Update 'mkdocs' to 1.4.2 Upgrade 'mkdocs-material' to 9.0.15
yashaka · Feb 27, 2023 · d8d214a · d8d214a
1 parent 79945e4
commit d8d214a
Show file tree

Hide file tree

Showing 14 changed files with 189 additions and 86 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -88,5 +88,5 @@ pages.
 <!-- --8<-- [end:githubSection] -->
 
 <!-- GitHub only references -->
-[code-conventions]: https://yashaka.github.io/selene/contribution/code-conventions.guide/
-[release-workflow]: https://yashaka.github.io/selene/contribution/release-workflow.guide/
+[code-conventions]: https://yashaka.github.io/selene/contribution/code-conventions-guide/
+[release-workflow]: https://yashaka.github.io/selene/contribution/release-workflow-guide/
diff --git a/README.md b/README.md
@@ -6,17 +6,17 @@
 [![codecov](https://codecov.io/gh/yashaka/selene/branch/master/graph/badge.svg)](https://codecov.io/gh/yashaka/selene)
 ![Free](https://img.shields.io/badge/free-open--source-green.svg)
 [![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yashaka/selene/blob/master/LICENSE)
+
+[![Downloads](https://pepy.tech/badge/selene)](https://pepy.tech/project/selene)
 [![Project Template](https://img.shields.io/badge/project-template-9cf.svg)](https://github.com/yashaka/python-web-test)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Downloads](https://pepy.tech/badge/selene)](https://pepy.tech/project/selene)
 
 [![Join telegram chat https://t.me/selene_py](https://img.shields.io/badge/chat-telegram-blue)](https://t.me/selene_py)
 [![Присоединяйся к чату https://t.me/selene_py_ru](https://img.shields.io/badge/%D1%87%D0%B0%D1%82-telegram-red)](https://t.me/selene_py_ru)
 
-[![Sign up for a course https://autotest.how/selene](https://img.shields.io/badge/course-sign_up-blue)](https://autotest.how/selene)
-[![Запишись на курс https://autotest.how/selene-ru](https://img.shields.io/badge/%D0%BD%D0%B0%D0%B1%D0%BE%D1%80-%D0%BD%D0%B0%20%D0%BA%D1%83%D1%80%D1%81-red)](https://autotest.how/selene-ru)
-[![Учи Selene https://leanpub.com/selene-automation-ru](https://img.shields.io/badge/%D0%BA%D0%BD%D0%B8%D0%B3%D0%B0-leanpub-red)](https://leanpub.com/selene-automation-ru)
-[![Реєструйся на курс https://autotest.how/selene-uk](https://img.shields.io/badge/%D0%BD%D0%B0%D0%B1%D1%96%D1%80-%D0%BD%D0%B0_%D0%BA%D1%83%D1%80%D1%81-yellow)](https://autotest.how/selene-uk)
+[![Sign up for a course https://autotest.how/sdet-start](https://img.shields.io/badge/course-sign_up-blue)](https://autotest.how/sdet-start)
+[![Запишись на курс https://autotest.how/sdet-start-ru](https://img.shields.io/badge/%D0%BD%D0%B0%D0%B1%D0%BE%D1%80-%D0%BD%D0%B0%20%D0%BA%D1%83%D1%80%D1%81-red)](https://autotest.how/sdet-start-ru)
+[![Реєструйся на курс https://autotest.how/sdet-start-uk](https://img.shields.io/badge/%D0%BD%D0%B0%D0%B1%D1%96%D1%80-%D0%BD%D0%B0_%D0%BA%D1%83%D1%80%D1%81-yellow)](https://autotest.how/sdet-start-uk)
 
 Main features:
 
@@ -460,6 +460,6 @@ TBD
 <!-- --8<-- [end:githubSection] -->
 
 <!-- GitHub only references -->
-[contribution]: https://yashaka.github.io/selene/contribution/to-source-code.guide/
-[release-workflow]: https://yashaka.github.io/selene/contribution/release-workflow.guide/
+[contribution]: https://yashaka.github.io/selene/contribution/to-source-code-guide/
+[release-workflow]: https://yashaka.github.io/selene/contribution/release-workflow-guide/
 [changelog]: https://yashaka.github.io/selene/changelog/
diff --git a/docs/contribution/code-conventions.guide.md → docs/contribution/code-conventions-guide.md b/docs/contribution/code-conventions.guide.md → docs/contribution/code-conventions-guide.md
diff --git a/...ion/documentation-for-project.tutorial.md → ...ion/documentation-for-project-tutorial.md b/...ion/documentation-for-project.tutorial.md → ...ion/documentation-for-project-tutorial.md
diff --git a/...ontribution/how-to-organize-docs.guide.md → ...ontribution/how-to-organize-docs-guide.md b/...ontribution/how-to-organize-docs.guide.md → ...ontribution/how-to-organize-docs-guide.md
@@ -16,20 +16,20 @@ alongside the `mkdocs.yml` configuration file.
 - Try to pick concise and descriptive filename
 (coping the whole header is not always a good idea).
 - Tag (label) document type at the end of filename,
-separated by `.` (dot) and before `.md` extension,
+separated by `-` (hyphen) as well and before `.md` extension,
 sticking to the following recommendations:
-    - `*.guide.md` - like "long-read" with detailed explanation,
-    or article about fundamental things (e.g. `quick-start.guide.md`);
-    - `*.howto.md` - document type is more focused on
+    - `*-guide.md` - like "long-read" with detailed explanation,
+    or article about fundamental things (e.g. `quick-start-guide.md`);
+    - `*-howto.md` - document type is more focused on
     solving certain task / issue / problem.
     A good choice for pages in FAQ section.
     Please, avoid duplication of "how-to" in the filename
-    (e.g. `custom-chrome-profile.howto.md`)
-    - `*.tutorial.md` - step by step instruction
-    (e.g. `deploy-selenium-grid.tutorial.md`);
-    - `*.example.md` - demonstrates usage of Selene.
+    (e.g. `custom-chrome-profile-howto.md`)
+    - `*-tutorial.md` - step by step instruction
+    (e.g. `deploy-selenium-grid-tutorial.md`);
+    - `*-example.md` - demonstrates usage of Selene.
     Use Cases section is the right place for these documents
-    (e.g. `allure-step-annotations.example.md`)
+    (e.g. `allure-step-annotations-example.md`)
 
 <!-- markdownlint-disable MD046 -->
 !!! warning "Don't use names which begin with a dot"
@@ -50,16 +50,16 @@ Given this layout, pages would be generated for the following URLs:
     ```plain
     📁 docs/
     ├── 📁 contribution/
-        ├── 📄 to-source-code.guide.md
-        └── 📄 code-conventions.guide.md
+        ├── 📄 to-source-code-guide.md
+        └── 📄 code-conventions-guide.md
     ├── 📄 index.md
     └── 📄 license.md
     ```
 
 === "URLs"
 
-    /contribution/to-source-code.guide/  
-    /contribution/code-conventions.guide/  
+    /contribution/to-source-code-guide/  
+    /contribution/code-conventions-guide/  
     /  
     /license/
 <!-- markdownlint-enable MD046 -->
@@ -114,33 +114,33 @@ Selene has following file layout:
         ├── 🎨 logo-icon.png
         └── 🎨 favicon.png
 ├── 📁 contribution/
-    ├── 📄 code-conventions.guide.md
-    ├── 📄 how-to-organize-docs.guide.md
-    ├── 📄 how-to-write-docs.guide.md
+    ├── 📄 code-conventions-guide.md
+    ├── 📄 how-to-organize-docs-guide.md
+    ├── 📄 how-to-write-docs-guide.md
     ├── 📄 index.md
-    ├── 📄 release-workflow.guide.md
-    ├── 📄 to-documentation.guide.md
-    └── 📄 to-source-code.guide.md
+    ├── 📄 release-workflow-guide.md
+    ├── 📄 to-documentation-guide.md
+    └── 📄 to-source-code-guide.md
 ├── 📁 faq/
     ├── 📁 assets/
         └── 🎨 chrome-driver-window.png
     ├── 📄 index.md
     ├── 📄 q-tbd-1.howto.md
-    └── 📄 custom-chrome-profile.howto.md
+    └── 📄 custom-chrome-profile-howto.md
 ├── 📁 learn-advanced/
     ├── 📁 assets/
     ├── 📄 index.md
-    ├── 📄 learn-deeper-1.tutorial.md
-    └── 📄 learn-deeper-2.guide.md
+    ├── 📄 learn-deeper-1-tutorial.md
+    └── 📄 learn-deeper-2-guide.md
 ├── 📁 learn-basics/
     ├── 📄 index.md
-    ├── 📄 quick-start.tutorial.md
-    └── 📄 learn-something.tutorial.md
+    ├── 📄 quick-start-tutorial.md
+    └── 📄 learn-something-tutorial.md
 ├── 📁 use-cases/
     ├── 📁 assets/
         └── 🎨 my-pic.png
-    ├── 📄 ex-tbd-1.example.md
-    ├── 📄 ex-tbd-2.example.md
+    ├── 📄 ex-tbd-1-example.md
+    ├── 📄 ex-tbd-2-example.md
     └── 📄 index.md
 ├── 📄 changelog.md
 ├── 📄 index.md
@@ -155,7 +155,7 @@ Separate links are required because README is rendered on three place:
 GitHub, PyPI and Selene documentation website.
 - `docs/license.md` and `docs/changelog.md` are full snippets of
 LICENSE.md and CHANGELOG.md from the project root.
-- `contribution/to-source-code.guide.md` is snippet
+- `contribution/to-source-code-guide.md` is snippet
 of CONTRIBUTING.md from the root
 (except two links at the end of the page).
 - Images for each section (page type) are located in `assets` subfolder.
@@ -188,5 +188,5 @@ License
 
 <!-- References -->
 [mkdocs-user-guide]: https://www.mkdocs.org/user-guide/writing-your-docs/
-[syntax-guide]: how-to-write-docs.guide.md
+[syntax-guide]: how-to-write-docs-guide.md
 [snippets-doc]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
diff --git a/docs/contribution/how-to-write-docs.guide.md → docs/contribution/how-to-write-docs-guide.md b/docs/contribution/how-to-write-docs.guide.md → docs/contribution/how-to-write-docs-guide.md
diff --git a/docs/contribution/index.md b/docs/contribution/index.md
@@ -2,16 +2,16 @@
 
 ## Contribute to source code
 
-- [How to contribute](to-source-code.guide.md)
-- [Code conventions](code-conventions.guide.md)
-- [Release workflow](release-workflow.guide.md)
+- [How to contribute](to-source-code-guide.md)
+- [Code conventions](code-conventions-guide.md)
+- [Release workflow](release-workflow-guide.md)
 
 ## Contribute to documentation
 
-- [How to contribute to documentation](to-documentation.guide.md)
-- [How to organize documentation](how-to-organize-docs.guide.md)
-- [How to write documentation](how-to-write-docs.guide.md)
+- [How to contribute to documentation](to-documentation-guide.md)
+- [How to organize documentation](how-to-organize-docs-guide.md)
+- [How to write documentation](how-to-write-docs-guide.md)
 
 ## Project related documents
 
-- [How to add documentation to your project](documentation-for-project.tutorial.md)
+- [How to add documentation to your project](documentation-for-project-tutorial.md)
diff --git a/docs/contribution/release-workflow.guide.md → docs/contribution/release-workflow-guide.md b/docs/contribution/release-workflow.guide.md → docs/contribution/release-workflow-guide.md
diff --git a/docs/contribution/to-documentation.guide.md → docs/contribution/to-documentation-guide.md b/docs/contribution/to-documentation.guide.md → docs/contribution/to-documentation-guide.md
@@ -152,13 +152,13 @@ please refer to its [GitHub page][markdownlint-cli2-github].
 <!-- markdownlint-enable MD046 -->
 
 <!-- References -->
-[contributing]: to-source-code.guide.md
+[contributing]: to-source-code-guide.md
 [markdownlint-extension]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
 [vale-cli-plugin]: https://plugins.jetbrains.com/plugin/19613-vale-cli
 [vale-github-flavored-markdown]: https://vale.sh/docs/topics/scoping/#markdown
 [awesome-console-plugin]: https://plugins.jetbrains.com/plugin/7677-awesome-console
 [markdownlint-cli2-github]: https://github.com/DavidAnson/markdownlint-cli2
 [pymarkdown-linter]: https://github.com/jackdewinter/pymarkdown
 [markdownlint-cli1-github]: https://github.com/igorshubovych/markdownlint-cli
-[organizing-docs]: how-to-organize-docs.guide.md
-[writing-docs]: how-to-write-docs.guide.md
+[organizing-docs]: how-to-organize-docs-guide.md
+[writing-docs]: how-to-write-docs-guide.md
diff --git a/docs/contribution/to-source-code.guide.md → docs/contribution/to-source-code-guide.md b/docs/contribution/to-source-code.guide.md → docs/contribution/to-source-code-guide.md
@@ -3,6 +3,6 @@
 <!--References for web-->
 
 <!-- markdownlint-disable MD053 -->
-[code-conventions]: code-conventions.guide.md
-[release-workflow]: release-workflow.guide.md
+[code-conventions]: code-conventions-guide.md
+[release-workflow]: release-workflow-guide.md
 <!-- markdownlint-enable MD053 -->
diff --git a/docs/index.md b/docs/index.md
@@ -3,7 +3,7 @@
 <!--References for web-->
 
 <!-- markdownlint-disable MD053 -->
-[contribution]: contribution/to-source-code.guide.md
-[release-workflow]: contribution/release-workflow.guide.md
+[contribution]: contribution/to-source-code-guide.md
+[release-workflow]: contribution/release-workflow-guide.md
 [changelog]: changelog.md
 <!-- markdownlint-enable MD053 -->
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,20 +13,20 @@ repo_url: https://github.com/yashaka/selene
 nav:
   - Overview: index.md
   # - Learn Basics:
-  #   - Stub Title 1: learn-basics/automate-testing.guide.md
+  #   - Stub Title 1: learn-basics/automate-testing-guide.md
   # - Learn Advanced:
-  #   - Stub Title 1: learn-advanced/automate-testing.guide.md
+  #   - Stub Title 1: learn-advanced/automate-testing-guide.md
   # - FAQ:
-  #   - Stub Title 1: faq/custom-chrome-profile.howto.md
+  #   - Stub Title 1: faq/custom-chrome-profile-howto.md
   # - Use Cases:
-  #   - Stub Title 1: use-cases/path-to-some.example.md
+  #   - Stub Title 1: use-cases/path-to-some-example.md
   - Contribution:
-    - How to contribute: contribution/to-source-code.guide.md
-    - Code conventions: contribution/code-conventions.guide.md
-    - Release workflow: contribution/release-workflow.guide.md
-    - How to contribute to docs: contribution/to-documentation.guide.md
-    - How to organize docs: contribution/how-to-organize-docs.guide.md
-    - How to write docs: contribution/how-to-write-docs.guide.md
+    - How to contribute: contribution/to-source-code-guide.md
+    - Code conventions: contribution/code-conventions-guide.md
+    - Release workflow: contribution/release-workflow-guide.md
+    - How to contribute to docs: contribution/to-documentation-guide.md
+    - How to organize docs: contribution/how-to-organize-docs-guide.md
+    - How to write docs: contribution/how-to-write-docs-guide.md
   - Changelog: changelog.md
   - License: license.md
 
@@ -86,7 +86,7 @@ plugins:
   - mkdocstrings
   - redirects:
       redirect_maps:
-          CONTRIBUTING.md: contribution/to-source-code.guide.md
+          CONTRIBUTING.md: contribution/to-source-code-guide.md
 
 # Extensions
 markdown_extensions: