delei commented on PR #841: URL: https://github.com/apache/fesod/pull/841#issuecomment-3827964217
> 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 marklint rules file `.markdownlint-cli2.jsonc` can be modified. Please follow the steps below to make the adjustments. ## Step 01 Add a rule to the `config` in `.markdownlint-cli2.jsonc` file ```json "MD022": false, ``` ## Step 02 Adjust the position of the ASF header comments, for example: ```markdown --- 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. --> ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
