HDDS-14546. [Website v2] Add `lint` and `lint:fix` commands by yuriipalam · Pull Request #318 · apache/ozone-site

yuriipalam · 2026-02-02T14:02:29Z

What changes were proposed in this pull request?

Add lint and lint:fix commands that run markdownlint and yamllint packages.

lint just checks for errors
lint:fix actually fixes issues which are possible to fix automatically. It doesn't work for yamllint though, it can only check the files.

In the next PR we plan to integrate the ESLint plugin.

There were some issues with the markdown files found by markdownlint. I fixed them, but it has to be reviewed by someone since I'm not familiar with the product. Some things required manual fixing, like proper heading ordering. markdownlint prohibits bypassing heading levels, e.g., jump from an h2 to h4 without an h3 heading between the two.

What is the link to the Apache Jira?

HDDS-14546

How was this patch tested?

The CI checks on my fork are passing
I verified the rendered content using a local preview
I manually verified the steps provided in this change work as described

…re launching it (apache#326)" This reverts commit 20b71d0. Apply this commit to the master branch, not the HDDS-9225-website-v2 branch. We could still use this branch for future staging development

smengcl · 2026-02-12T17:23:21Z

PSA: Please switch PR target branch to apache:master now that the v2 website has launched.

yuriipalam · 2026-02-18T12:56:16Z

@smengcl can I have a review please?

smengcl · 2026-02-19T02:22:43Z

docusaurus.config.js

I don't think the changes in this file of this PR is valid? Those are the remainder from the v2 launch.

Agree, the new site is live. We should use the master branch's version.

Copilot

Pull request overview

This pull request adds linting capabilities to the Apache Ozone website v2 project by introducing lint and lint:fix npm scripts that run markdownlint and yamllint checks. The PR consolidates the previous separate GitHub Actions workflows for markdown and YAML linting into a single unified lint job, removes the now-redundant shell scripts, and fixes markdown heading level issues discovered by markdownlint in the release notes files. Additionally, it updates the docusaurus configuration with TODO comments and temporary URLs for the staging environment.

Changes:

Added lint and lint:fix commands to package.json for running markdownlint and yamllint
Consolidated GitHub Actions workflows by merging lint-markdown and lint-yaml jobs into a single lint job
Fixed markdown heading hierarchy in release notes to comply with markdownlint rules and Keep a Changelog format

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
package.json	Added lint and lint:fix scripts for running markdownlint and yamllint
.github/workflows/static.yml	Consolidated lint-markdown and lint-yaml jobs into single lint job
.github/scripts/markdownlint.sh	Removed - functionality moved to package.json script
.github/scripts/yamllint.sh	Removed - functionality moved to package.json script
src/pages/release-notes/2.1.0.md	Fixed heading levels to follow proper hierarchy (h3→h4 for changelog subsections, h2→h3 for Downloads/Documentation)
src/pages/release-notes/2.0.0.md	Fixed heading levels to follow proper hierarchy
docusaurus.config.js	Added TODO comments and updated URLs/regex for staging environment
CONTRIBUTING.md	Documented new lint commands and their usage

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-19T02:26:26Z

package.json

-    "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)\""


Extra leading space in the lint:fix script value. The value should start with "markdownlint" not " markdownlint".

Suggested change

"lint:fix": " markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""

"lint:fix": "markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""

Copilot · 2026-02-19T02:26:27Z

package.json

+    "lint": "markdownlint . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",
+    "lint:fix": " markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""


The yamllint command is used in both lint scripts but yamllint is not listed as a dependency in package.json. 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, or explore using a Node.js-based YAML linter that can be added as a devDependency.

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?

docusaurus.config.js

ptlrs · 2026-02-26T19:05:29Z

@yuriipalam Could you please fix the config.js file and resolve the conflicts?

yuriipalam · 2026-02-27T16:01:06Z

Sure @ptlrs
Done

errose28

Thanks for adding this @yuriipalam. Can you address the open comments from the AI as well, they look valid.

I think this was broken before this PR, but while we are making changes in this area we should add build to the ignore list in the yamllint config. This passes in CI because lint is run before build, but it will fail for developers locally if they have an old build and then try to lint their current changes before building again.

docusaurus.config.js

src/pages/release-notes/2.0.0.md

package.json

errose28 · 2026-03-02T22:26:20Z

package.json

+    "lint": "markdownlint . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",
+    "lint:fix": " markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""


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?

yuriipalam · 2026-03-03T15:33:59Z

Thanks for the review @errose28
I adopted the requested changes, asking for another review.

errose28 · 2026-03-03T20:34:16Z

We just need to close the loop on this markdown change but everything else looks good!

errose28

Thanks for adding this @yuriipalam. I just added back the 2.0.0 release page from master as well to fix the same as 2.1.0. Once CI is green this should be ready to merge.

yuriipalam added 2 commits February 2, 2026 14:59

[Website v2] Add lint and lint:fix commands

dd05dd0

Update docs

7cc3be0

errose28 mentioned this pull request Feb 2, 2026

HDDS-9570. [Website v2] Integrate eslint and run it in github actions #307

Closed

3 tasks

jojochuang and others added 2 commits February 9, 2026 14:08

Revert "HDDS-12129. Allow search engines to index the v2 website befo…

ec571d3

…re launching it (apache#326)" This reverts commit 20b71d0. Apply this commit to the master branch, not the HDDS-9225-website-v2 branch. We could still use this branch for future staging development

Merge branch 'HDDS-9225-website-v2' into HDDS-14546

94135b1

github-actions bot added the website-v2 Tasks for the new ozone website targeting the HDDS-9225-website-v2 branch label Feb 10, 2026

jojochuang changed the base branch from HDDS-9225-website-v2 to master February 12, 2026 19:24

Merge branch 'master' into HDDS-14546

bb243d3

smengcl requested a review from Copilot February 19, 2026 02:20

Copilot started reviewing on behalf of smengcl February 19, 2026 02:21 View session

smengcl reviewed Feb 19, 2026

View reviewed changes

Copilot AI reviewed Feb 19, 2026

View reviewed changes

Merge branch 'master' into HDDS-14546

5265838

yuriipalam requested a review from ptlrs February 27, 2026 16:00

errose28 reviewed Mar 2, 2026

View reviewed changes

Adopt requested changes

5b5d449

yuriipalam requested a review from errose28 March 3, 2026 15:33

yuriipalam and others added 2 commits March 4, 2026 10:49

Use 2.1.0.md from master

ef9e967

Also use 2.0.0 from master

34083ce

errose28 approved these changes Mar 4, 2026

View reviewed changes

errose28 merged commit fbae715 into apache:master Mar 4, 2026
11 checks passed

	"lint:fix": " markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""
	"lint:fix": "markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""

		"lint": "markdownlint . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",
		"lint:fix": " markdownlint --fix . && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""

Conversation

yuriipalam commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

What is the link to the Apache Jira?

How was this patch tested?

Uh oh!

smengcl commented Feb 12, 2026

Uh oh!

yuriipalam commented Feb 18, 2026

Uh oh!

smengcl Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

ptlrs Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ptlrs commented Feb 26, 2026

Uh oh!

yuriipalam commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

errose28 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

errose28 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

yuriipalam commented Mar 3, 2026

Uh oh!

errose28 commented Mar 3, 2026

Uh oh!

errose28 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

yuriipalam commented Feb 2, 2026 •

edited

Loading

yuriipalam commented Feb 27, 2026 •

edited

Loading