Skip to content

Conversation

@hrittijab
Copy link

Purpose of the pull request

Related: #840

What's changed?

Added missing Apache Software Foundation (ASF) Apache 2.0 license headers
to Markdown documentation files under website/docs that are included in
the source release.

No functional or content changes were made.

Checklist

  • I have read the Contributor Guide.
  • I have written the necessary doc or comment.
  • I have added the necessary unit tests and all cases have passed.

@delei delei added the PR: first-time contributor first-time contributor label Jan 31, 2026
@delei
Copy link
Member

delei commented Jan 31, 2026

Hi @hrittijab

Please refer to document document-format-inspection to check and fix any document formatting problems.

In the local development environment, try to execute the following command

pnpm md-lint

@hrittijab
Copy link
Author

Hi @delei, thanks again for the guidance!

Before proceeding further, I just wanted to confirm expectations:
for the markdownlint errors (especially MD003 heading-style and MD041 first-line-heading), should I fully update the existing docs to match the configured rules (convert headings to setext style and adjust for front matter), or is it acceptable to disable or relax those rules for docs that already rely on front matter and ATX-style headings?
I want to make sure I’m aligning with the preferred approach before applying changes across more files. Thanks!

@delei
Copy link
Member

delei commented Jan 31, 2026

Hi @delei, thanks again for the guidance!

Before proceeding further, I just wanted to confirm expectations: for the markdownlint errors (especially MD003 heading-style and MD041 first-line-heading), should I fully update the existing docs to match the configured rules (convert headings to setext style and adjust for front matter), or is it acceptable to disable or relax those rules for docs that already rely on front matter and ATX-style headings? I want to make sure I’m aligning with the preferred approach before applying changes across more files. Thanks!

Hi, @hrittijab

The markdownlint rules file .markdownlint-cli2.jsonc can be modified. Please follow the steps below to make the adjustments.

Step 01

Add some rules to the config in .markdownlint-cli2.jsonc file

"MD022": false,
"MD041": false,

Step 02

Adjust the position of the ASF header comments, for example:

---
id: 'download'
title: 'Download'
---

<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements.  See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License.  You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-->

FYI, I tested it in the local development environment and it worked properly.

@delei delei changed the title Add missing ASF license headers to website docs docs: Add missing ASF license headers to website docs Jan 31, 2026
@@ -1,8 +1,27 @@

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove these blank lines

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These unnecessary blank lines cause errors when the ci workflow performs the build process.

@@ -1,8 +1,27 @@

---

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove these blank lines

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the modification, please try to run pnpm run build in your local development environment to ensure that the website can be successfully built.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the note! I’ve removed the extra blank lines as suggested.

I ran pnpm run build locally afterward, and I’m seeing a build failure related to some document IDs referenced in sidebarsCommunity.js. Before making further changes, I just wanted to double-check whether this is expected on my side or if there’s anything I might be missing locally.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can submit the revised part of the code. When it's convenient for me, I can assist you in further processing it.

- Fixed sidebar doc ID references to match actual filenames
- Updated Chinese translation frontmatter IDs
- Updated documentation files
@hrittijab hrittijab requested a review from delei February 3, 2026 07:17
"default": true,
"MD001": true,
"MD003": true,
"MD003": false,
Copy link
Member

@delei delei Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just as I mentioned in the comment, I think setting the MD003 to false is unnecessary.

I believe that the heading style in the website/community/ directory should be consistent with that in the website/doc/ directory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: first-time contributor first-time contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants