From 045720399f2d2162fed5335e70e1492b7a8104f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Sun, 28 Mar 2021 19:24:07 +0200 Subject: [PATCH] Use jekyll tags properly, create apex page placeholder --- docs/_data/sidebars/pmd_sidebar.yml | 9 ++++++--- docs/_data/tags.yml | 2 +- docs/pages/pmd/languages/apex.md | 10 ++++++++++ docs/pages/pmd/languages/java.md | 3 +++ docs/pages/pmd/languages/jsp.md | 2 ++ docs/pages/pmd/languages/plsql.md | 4 +++- .../pages/pmd/userdocs/extending/writing_java_rules.md | 3 +-- docs/pages/tags/tag_languages.md | 2 +- 8 files changed, 27 insertions(+), 8 deletions(-) create mode 100644 docs/pages/pmd/languages/apex.md diff --git a/docs/_data/sidebars/pmd_sidebar.yml b/docs/_data/sidebars/pmd_sidebar.yml index 8e2100a18f..7bda470a8a 100644 --- a/docs/_data/sidebars/pmd_sidebar.yml +++ b/docs/_data/sidebars/pmd_sidebar.yml @@ -349,13 +349,16 @@ entries: - title: Performance output: web, pdf url: /pmd_rules_xsl_performance.html - - title: Language Specific Documentation + - title: Language-Specific Documentation output: web, pdf folderitems: - - title: Java Support + - title: Apex + url: /pmd_languages_apex.html + output: web, pdf + - title: Java url: /pmd_languages_java.html output: web, pdf - - title: JSP Support + - title: JSP url: /pmd_languages_jsp.html output: web, pdf - title: PLSQL diff --git a/docs/_data/tags.yml b/docs/_data/tags.yml index 0fe60c394a..88d01cea93 100644 --- a/docs/_data/tags.yml +++ b/docs/_data/tags.yml @@ -9,4 +9,4 @@ allowed-tags: - metrics # About using metrics, and metrics indices - tools # About tools and integrations, Maven, gradle, etc. - devdocs # About PMD internals, contributing, building, projects - - languages + - languages # Language-specific documentation pages diff --git a/docs/pages/pmd/languages/apex.md b/docs/pages/pmd/languages/apex.md new file mode 100644 index 0000000000..f6ff6b50cc --- /dev/null +++ b/docs/pages/pmd/languages/apex.md @@ -0,0 +1,10 @@ +--- +title: Apex support +permalink: pmd_languages_apex.html +author: Clément Fournier +last_updated: March 2021 (7.0.0) +tags: [languages] +summary: "Apex-specific features and guidance" +--- + +{% include warning.html content="Todo for pmd 7" %} diff --git a/docs/pages/pmd/languages/java.md b/docs/pages/pmd/languages/java.md index 58dfcb13d7..cbe060e53b 100644 --- a/docs/pages/pmd/languages/java.md +++ b/docs/pages/pmd/languages/java.md @@ -2,6 +2,9 @@ title: Java support permalink: pmd_languages_java.html author: Clément Fournier +last_updated: March 2021 (7.0.0) +tags: [languages] +summary: "Java-specific features and guidance" --- {% include warning.html content="WIP, todo for pmd 7" %} diff --git a/docs/pages/pmd/languages/jsp.md b/docs/pages/pmd/languages/jsp.md index 771f7af06a..31b4995e54 100644 --- a/docs/pages/pmd/languages/jsp.md +++ b/docs/pages/pmd/languages/jsp.md @@ -2,6 +2,8 @@ title: JSP Support permalink: pmd_languages_jsp.html author: Pieter Vanraemdonck +tags: [languages] +summary: "JSP-specific features and guidance" --- ## What is currently supported and what is not diff --git a/docs/pages/pmd/languages/plsql.md b/docs/pages/pmd/languages/plsql.md index fc6b6d7bb2..38f22bab03 100644 --- a/docs/pages/pmd/languages/plsql.md +++ b/docs/pages/pmd/languages/plsql.md @@ -1,7 +1,9 @@ --- -title: PLSQL +title: PLSQL Support permalink: pmd_languages_plsql.html last_updated: March 2021 (6.33.0) +tags: [languages] +summary: "PLSQL-specific features and guidance" --- ## Parsing Exclusions diff --git a/docs/pages/pmd/userdocs/extending/writing_java_rules.md b/docs/pages/pmd/userdocs/extending/writing_java_rules.md index 82b9a4941b..14619958b7 100644 --- a/docs/pages/pmd/userdocs/extending/writing_java_rules.md +++ b/docs/pages/pmd/userdocs/extending/writing_java_rules.md @@ -27,6 +27,7 @@ your rule as you add test cases. In this page we'll talk about rules for the Java language, but the process is very similar for other languages. +{% include note.html content="[Please find an index of language-specific documentation here](tag_languages.html)" %} ## Basics @@ -133,8 +134,6 @@ The start method is called exactly once per file. - - ## Rule lifecycle reference ### Construction diff --git a/docs/pages/tags/tag_languages.md b/docs/pages/tags/tag_languages.md index 886d150173..c074dbcc09 100644 --- a/docs/pages/tags/tag_languages.md +++ b/docs/pages/tags/tag_languages.md @@ -1,5 +1,5 @@ --- -title: "Supported Lanugages" +title: "Supported Languages" tagName: languages search: exclude permalink: tag_languages.html