-
Notifications
You must be signed in to change notification settings - Fork 481
docs: Add missing ASF license headers to website docs #841
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
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 |
|
Hi @delei, thanks again for the guidance! Before proceeding further, I just wanted to confirm expectations: |
Hi, @hrittijab The markdownlint rules file Step 01Add some rules to the "MD022": false,
"MD041": false,Step 02Adjust 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. |
website/docs/quickstart/example.md
Outdated
| @@ -1,8 +1,27 @@ | |||
|
|
|||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
website/docs/quickstart/example.md
Outdated
| @@ -1,8 +1,27 @@ | |||
|
|
|||
| --- | |||
|
|
|||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
| "default": true, | ||
| "MD001": true, | ||
| "MD003": true, | ||
| "MD003": false, |
There was a problem hiding this comment.
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.
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