Re: [PR] HDDS-14546. [Website v2] Add `lint` and `lint:fix` commands [ozone-site]

["errose28 (via GitHub)" <gi...@apache.org>]

errose28 commented on code in PR #318:
URL: https://github.com/apache/ozone-site/pull/318#discussion_r2874906970


##########
src/pages/release-notes/2.0.0.md:
##########
@@ -144,7 +144,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Unit tests and documentation for creating keys/files with EC replication config using ofs/o3fs. ([HDDS-10553](https://issues.apache.org/jira/browse/HDDS-10553))
 - Support for passing Kerberos credentials in GrpcOmTransport. ([HDDS-11041](https://issues.apache.org/jira/browse/HDDS-11041))
 
-### Changed

Review Comment:
   Were these failing markdown lint before? The original headings look correct. Same with the 2.1.0 release notes page.



##########
package.json:
##########
@@ -12,7 +12,9 @@
     "clear": "docusaurus clear",
     "serve": "docusaurus serve --port 3001",
     "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids"
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "lint": "markdownlint . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",
+    "lint:fix": " markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""

Review Comment:
   > While yamllint is pre-installed on GitHub Actions runners, developers running these commands locally will need to install yamllint separately via pip or their package manager. Consider adding a note in the CONTRIBUTING.md file about this prerequisite
   
   @yuriipalam can you add this to the contributing guide?



##########
package.json:
##########
@@ -12,7 +12,9 @@
     "clear": "docusaurus clear",
     "serve": "docusaurus serve --port 3001",
     "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids"
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "lint": "markdownlint . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",

Review Comment:
   We should use `$(git rev-parse --show-toplevel)` for both commands so all files are processed regardless of the working directory.



##########
docusaurus.config.js:
##########
@@ -268,7 +272,8 @@ const config = {
             const {defaultCreateSitemapItems, ...rest} = params;
             const items = await defaultCreateSitemapItems(rest);
 
-            const validUrlRegex = /^https:\/\/ozone\.apache\.org\/([a-z0-9][a-z0-9./-]*[a-z0-9/])?$/;
+            // TODO Base URL must be updated when the new website's branch is merged.
+            const validUrlRegex = new RegExp('^https://ozone-site-v2\.staged\.apache\.org/([a-z0-9][a-z0-9\./-]*[a-z0-9/])?$');

Review Comment:
   The changes above this line are left over from before v2 got merged with master. We should remove them instead of re-introducing them.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org