diff --git a/website/.markdownlint-cli2.jsonc b/website/.markdownlint-cli2.jsonc index 2f2131016..bdd571559 100644 --- a/website/.markdownlint-cli2.jsonc +++ b/website/.markdownlint-cli2.jsonc @@ -4,6 +4,8 @@ "default": true, "MD001": true, "MD003": true, + "MD022": false, + "MD041": false, "MD013": { "line_length": 600, "code_blocks": false, diff --git a/website/community/brand.md b/website/community/brand.md index c551e2f19..bcb3392ce 100644 --- a/website/community/brand.md +++ b/website/community/brand.md @@ -3,6 +3,23 @@ id: 'brand' title: 'Brand' --- + + ## Logo ![logo](/img/logo/fesod-logo-icon.svg) diff --git a/website/community/committer/become-committer.md b/website/community/committer/become-committer.md index e5e3ea6ee..d0be3d6e9 100644 --- a/website/community/committer/become-committer.md +++ b/website/community/committer/become-committer.md @@ -3,6 +3,23 @@ id: 'become-committer' title: 'Become A Committer' --- + + Anyone being supportive of the community and working in any of the CoPDoC areas can become an Apache Fesod (Incubating) committer. The CoPDoC is an acronym from ASF to describe how we recognize your contributions not only by code. - **(Co)mmunity** - You can join us via our mailing list, issue diff --git a/website/community/committer/icla.md b/website/community/committer/icla.md index ac853ea65..840e420c0 100644 --- a/website/community/committer/icla.md +++ b/website/community/committer/icla.md @@ -3,6 +3,23 @@ id: 'icla' title: 'Sign iCLA Guide' --- + + Apache CLA short for Apache Contributor License Agreement, the purpose of this agreement is to clearly define the terms under which intellectual property has been contributed to the ASF and thereby allow us to defend the project should there be a legal dispute regarding the software at some future time. A signed ICLA is required to be on file before an individual is given commit rights to any ASF project. The process of submitting iCLA are: diff --git a/website/community/committer/onboarding.md b/website/community/committer/onboarding.md index e270651a8..6920d1e9e 100644 --- a/website/community/committer/onboarding.md +++ b/website/community/committer/onboarding.md @@ -1,8 +1,25 @@ --- -id: 'committer-onboarding' +id: 'onboarding' title: 'Onboarding' --- + + Upon receiving an invitation email from Apache Fesod (Incubating) PPMC, a new committer should consider whether accepting. If they decide in favor, they should select "Reply All" and express their decision. Please provide the reference content of this reply email: diff --git a/website/community/contribution.md b/website/community/contribution.md index 622ac7d7d..e2063ab5c 100644 --- a/website/community/contribution.md +++ b/website/community/contribution.md @@ -3,6 +3,23 @@ id: 'contribution' title: 'Contributor Guide' --- + + Welcome every user and developer in the community to become contributors. Whether it's reporting issues, improving documentation, submitting code, or providing technical support, your participation will help make it better. ## Contribution Directions diff --git a/website/community/contribution/code-review-guide.md b/website/community/contribution/code-review-guide.md index ce4e060d9..02212917c 100644 --- a/website/community/contribution/code-review-guide.md +++ b/website/community/contribution/code-review-guide.md @@ -3,6 +3,23 @@ id: 'code-review-guide' title: 'Code Review Guidelines' --- + + This guide is for all committers and contributors that want to help with reviewing code contributions. Thank you for your effort - good reviews are one of the most important and crucial parts of an open source project. This guide should help the community to make reviews such that: - Contributors have a good contribution experience. diff --git a/website/community/contribution/commit-format.md b/website/community/contribution/commit-format.md index 758331f3b..615bd3f3a 100644 --- a/website/community/contribution/commit-format.md +++ b/website/community/contribution/commit-format.md @@ -3,6 +3,23 @@ id: 'commit-format' title: 'Commit Format Specification' --- + + All improvements can be implemented through Pull Request (PR). Before submitting a Pull Request, please familiarise yourself with the following guidelines: ### Commit Rules diff --git a/website/community/contribution/contribute-code.md b/website/community/contribution/contribute-code.md index 4dc322e2d..9955a6186 100644 --- a/website/community/contribution/contribute-code.md +++ b/website/community/contribution/contribute-code.md @@ -3,6 +3,23 @@ id: 'contribute-code' title: 'Code Contribution' --- + + This section explains how to build project from source code and also describe how to contribute code. ## Workspace Preparation diff --git a/website/community/contribution/contribute-doc.md b/website/community/contribution/contribute-doc.md index f9172589c..baa37b1ff 100644 --- a/website/community/contribution/contribute-doc.md +++ b/website/community/contribution/contribute-doc.md @@ -3,6 +3,23 @@ id: 'contribute-doc' title: 'Docs Contribution' --- + + This document contribution guide primarily explains how to modify and contribute to the documents. The official website is built using [Docusaurus](https://docusaurus.io/), and the documentation is maintained in the [website](https://github.com/apache/fesod/tree/main/website) directory.Please note that whether it is for historical versions or the latest version of the docs, all modifications should be submitted as pull requests on the `apache/fesod` repository. diff --git a/website/community/feedback.md b/website/community/feedback.md index 404c68369..2becdfa78 100644 --- a/website/community/feedback.md +++ b/website/community/feedback.md @@ -3,6 +3,23 @@ id: 'feedback' title: 'Feedback' --- + + We appreciate all the feedback and suggestions you have. If you find any bugs during use, you can submit the issue through the [NEW ISSUE](https://github.com/apache/fesod/issues/new/choose) page. ## Before Submitting diff --git a/website/community/index.md b/website/community/index.md index c2d7f57cb..b544fcc77 100644 --- a/website/community/index.md +++ b/website/community/index.md @@ -1,8 +1,25 @@ --- -id: 'community' +id: 'index' title: 'Join Community' --- + + Thank you very much for your interest in the Apache Fesod (Incubating). Every volunteer project obtains its strength from the people involved in it. We invite you to participate as much or as little as you choose. ## Initial contact diff --git a/website/community/maturity.md b/website/community/maturity.md index b5634a87f..5db1d7e69 100644 --- a/website/community/maturity.md +++ b/website/community/maturity.md @@ -3,6 +3,23 @@ id: 'maturity' title: 'Maturity' --- + + # Maturity The goals of this maturity model are to describe how Apache projects operate in a concise and high-level way, and to provide a basic framework that projects may choose to use to evaluate themselves. diff --git a/website/community/pmc/become-pmc-member.md b/website/community/pmc/become-pmc-member.md index bde8639ea..313f35259 100644 --- a/website/community/pmc/become-pmc-member.md +++ b/website/community/pmc/become-pmc-member.md @@ -3,6 +3,23 @@ id: 'become-pmc-member' title: 'Become A PPMC member' --- + + Anyone being supportive of the community and working in any of the CoPDoC areas can become an Apache Fesod (Incubating) PPMC member. The CoPDoC is an acronym from ASF to describe how we recognize your contributions not only by code. - **(Co)mmunity** - You can join us via our mailing list, issue trackers, discussions page to interact with community members, and share vision and knowledge diff --git a/website/community/pmc/nominate-committer.md b/website/community/pmc/nominate-committer.md index bd41f1ae9..7a26a8721 100644 --- a/website/community/pmc/nominate-committer.md +++ b/website/community/pmc/nominate-committer.md @@ -3,6 +3,23 @@ id: 'nominate-committer' title: 'Nominate Committer' --- + + This document mainly introduces how a PPMC member nominates a new committer. ## Template diff --git a/website/community/pmc/onboarding.md b/website/community/pmc/onboarding.md index ef8e19745..a83974975 100644 --- a/website/community/pmc/onboarding.md +++ b/website/community/pmc/onboarding.md @@ -1,8 +1,25 @@ --- -id: 'pmc-onboarding' +id: 'onboarding' title: 'Onboarding' --- + + This document primarily serves as a guide for new PPMC members to Apache Fesod (Incubating). Upon receiving an invitation email from Apache Fesod (Incubating) PPMC, a new PPMC member should consider whether accepting. diff --git a/website/community/release/release-version.md b/website/community/release/release-version.md index 3a5d33c4d..f3d685cce 100644 --- a/website/community/release/release-version.md +++ b/website/community/release/release-version.md @@ -3,6 +3,23 @@ id: 'release-version' title: 'How to Release' --- + + # 1. Preface ## 1.1 Apache Release Documentation diff --git a/website/community/release/verify-release.md b/website/community/release/verify-release.md index 13713919a..cd7c02fb3 100644 --- a/website/community/release/verify-release.md +++ b/website/community/release/verify-release.md @@ -2,6 +2,24 @@ id: 'verify-release' title: 'How to Verify Release' --- + + + For a detailed checklist, please refer to the official [Incubator Release Checklist](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist). ### 1. Download the Release Candidate diff --git a/website/community/security.md b/website/community/security.md index d1dde813c..82eabf675 100644 --- a/website/community/security.md +++ b/website/community/security.md @@ -3,6 +3,23 @@ id: 'security' title: 'Security' --- + + The Apache Software Foundation takes a rigorous stance on eliminating security issues in its software projects. Likewise, Apache Fesod (Incubating) is also vigilant and takes security issues related to its features and functionality into the highest consideration. If you have any concerns regarding Apache Fesod (Incubating)’s security, or you discover a vulnerability or potential threat, please don’t hesitate to get in touch with the [Apache Security Team](http://www.apache.org/security/) by dropping an email at [security@apache.org](mailto:security@apache.org). diff --git a/website/docs/download.md b/website/docs/download.md index 8f308319b..79bbc7ef7 100644 --- a/website/docs/download.md +++ b/website/docs/download.md @@ -3,6 +3,23 @@ id: 'download' title: 'Download' --- + + Here is the Apache Fesod (Incubating) official download page. Apache Fesod provides source releases that can be downloaded from the ASF distribution site. Binary artifacts are available through Maven Central. diff --git a/website/docs/introduce.md b/website/docs/introduce.md index 92e5f39ae..9b824ee39 100644 --- a/website/docs/introduce.md +++ b/website/docs/introduce.md @@ -4,6 +4,23 @@ title: 'Introduction' slug: / --- + + # Apache Fesod (Incubating) ## Introduction diff --git a/website/docs/migration/from-fastexcel.md b/website/docs/migration/from-fastexcel.md index 17b01c42c..b0c58657f 100644 --- a/website/docs/migration/from-fastexcel.md +++ b/website/docs/migration/from-fastexcel.md @@ -5,6 +5,23 @@ description: Complete migration guide for transitioning from cn.idev FastExcel t keywords: [fesod, migration, fastexcel, apache, excel, upgrade] --- + + # Migration Guide: FastExcel to Apache Fesod (Incubating) ## Overview diff --git a/website/docs/quickstart/example.md b/website/docs/quickstart/example.md index 171ef7640..cd1166321 100644 --- a/website/docs/quickstart/example.md +++ b/website/docs/quickstart/example.md @@ -3,6 +3,23 @@ id: 'simple-example' title: 'Simple example' --- + + ## Fesod Sheet Examples ### Read the spreadsheet diff --git a/website/docs/quickstart/guide.md b/website/docs/quickstart/guide.md index ffdf2f970..b7a1966bd 100644 --- a/website/docs/quickstart/guide.md +++ b/website/docs/quickstart/guide.md @@ -3,6 +3,23 @@ id: 'guide' title: 'Guide' --- + + # Installation ## Compatibility Information diff --git a/website/docs/sheet/fill/fill.md b/website/docs/sheet/fill/fill.md index a5f2ef14f..c0f85bb66 100644 --- a/website/docs/sheet/fill/fill.md +++ b/website/docs/sheet/fill/fill.md @@ -3,6 +3,23 @@ id: 'fill' title: 'Fill' --- + + # Fill This section explains how to use Fesod to fill data into files. diff --git a/website/docs/sheet/help/annotation.md b/website/docs/sheet/help/annotation.md index c6164d605..374511e0c 100644 --- a/website/docs/sheet/help/annotation.md +++ b/website/docs/sheet/help/annotation.md @@ -3,6 +3,23 @@ id: 'annotation' title: 'Annotation' --- + + # Annotation This section describes how to read annotations provided in the project. diff --git a/website/docs/sheet/help/core-class.md b/website/docs/sheet/help/core-class.md index d58a13f37..8e163ed28 100644 --- a/website/docs/sheet/help/core-class.md +++ b/website/docs/sheet/help/core-class.md @@ -3,6 +3,23 @@ id: 'core-class' title: 'Core Class' --- + + # Core Classes This section introduces the core classes in the project. diff --git a/website/docs/sheet/help/faq.md b/website/docs/sheet/help/faq.md index 55f63be25..220e27f17 100644 --- a/website/docs/sheet/help/faq.md +++ b/website/docs/sheet/help/faq.md @@ -3,6 +3,23 @@ id: 'faq' title: 'FAQ' --- + + # FAQ This section describes common issues that may arise when using this project. diff --git a/website/docs/sheet/help/large-data.md b/website/docs/sheet/help/large-data.md index f66d85dc7..40f3957e2 100644 --- a/website/docs/sheet/help/large-data.md +++ b/website/docs/sheet/help/large-data.md @@ -3,6 +3,23 @@ id: 'large-data' title: 'Large Data' --- + + # Big Data Files ## Reading diff --git a/website/docs/sheet/help/parameter.md b/website/docs/sheet/help/parameter.md index 63ee82083..bf5d5a643 100644 --- a/website/docs/sheet/help/parameter.md +++ b/website/docs/sheet/help/parameter.md @@ -3,6 +3,23 @@ id: 'parameter' title: 'Parameter' --- + + # Parameter This section introduces the parameters used in the project. diff --git a/website/docs/sheet/read/converter.md b/website/docs/sheet/read/converter.md index e8eaed518..242f73fcd 100644 --- a/website/docs/sheet/read/converter.md +++ b/website/docs/sheet/read/converter.md @@ -3,6 +3,23 @@ id: 'converter' title: 'Converter' --- + + # Format Conversion Fesod supports date, number, and custom format conversions. diff --git a/website/docs/sheet/read/csv.md b/website/docs/sheet/read/csv.md index a0663f6f6..4849b5266 100644 --- a/website/docs/sheet/read/csv.md +++ b/website/docs/sheet/read/csv.md @@ -3,6 +3,23 @@ id: 'csv' title: 'CSV' --- + + # Reading CSV Files This chapter introduces how to use Fesod to read custom CSV files. diff --git a/website/docs/sheet/read/exception.md b/website/docs/sheet/read/exception.md index 98b75e8ca..f1124d978 100644 --- a/website/docs/sheet/read/exception.md +++ b/website/docs/sheet/read/exception.md @@ -3,6 +3,23 @@ id: 'exception' title: 'Exception' --- + + # Exception Handling This chapter introduces how to handle exceptions. diff --git a/website/docs/sheet/read/extra.md b/website/docs/sheet/read/extra.md index 3e467815d..4bd6f63cb 100644 --- a/website/docs/sheet/read/extra.md +++ b/website/docs/sheet/read/extra.md @@ -3,6 +3,23 @@ id: 'extra' title: 'Extra' --- + + # Extra Information This chapter introduces how to read extra information such as comments, hyperlinks, merged cells, etc. diff --git a/website/docs/sheet/read/head.md b/website/docs/sheet/read/head.md index 418e4ceba..712df5386 100644 --- a/website/docs/sheet/read/head.md +++ b/website/docs/sheet/read/head.md @@ -3,6 +3,23 @@ id: 'head' title: 'Head' --- + + # Headers This chapter introduces how to read header data from the spreadsheet files. diff --git a/website/docs/sheet/read/num-rows.md b/website/docs/sheet/read/num-rows.md index d77d3cc5e..c226c6502 100644 --- a/website/docs/sheet/read/num-rows.md +++ b/website/docs/sheet/read/num-rows.md @@ -3,6 +3,23 @@ id: 'num-rows' title: 'Rows' --- + + # Reading Rows This chapter introduces how to read a specified number of rows. diff --git a/website/docs/sheet/read/pojo.md b/website/docs/sheet/read/pojo.md index 75cb62da4..644a6827c 100644 --- a/website/docs/sheet/read/pojo.md +++ b/website/docs/sheet/read/pojo.md @@ -3,6 +3,23 @@ id: 'pojo' title: 'POJO' --- + + # POJO This chapter introduces how to read data by configuring POJO classes. diff --git a/website/docs/sheet/read/sheet.md b/website/docs/sheet/read/sheet.md index f553eab3d..249f7b523 100644 --- a/website/docs/sheet/read/sheet.md +++ b/website/docs/sheet/read/sheet.md @@ -3,6 +3,23 @@ id: 'sheet' title: 'Sheet' --- + + # Sheet This chapter introduces how to configure Sheets to read data. diff --git a/website/docs/sheet/read/simple.md b/website/docs/sheet/read/simple.md index 1458e756c..7e684b92e 100644 --- a/website/docs/sheet/read/simple.md +++ b/website/docs/sheet/read/simple.md @@ -3,6 +3,23 @@ id: 'simple' title: 'Simple' --- + + # Simple Reading This chapter introduces how to use this project to perform simple spreadsheet reading operations. diff --git a/website/docs/sheet/read/spring.md b/website/docs/sheet/read/spring.md index f1c4d5a46..772929dc9 100644 --- a/website/docs/sheet/read/spring.md +++ b/website/docs/sheet/read/spring.md @@ -3,6 +3,23 @@ id: 'spring' title: 'Spring' --- + + # Spring Integration Guide This chapter introduces how to integrate and use Fesod in the Spring framework to handle spreadsheet files uploaded by diff --git a/website/docs/sheet/write/csv.md b/website/docs/sheet/write/csv.md index 4ecf0a2f9..6dee26251 100644 --- a/website/docs/sheet/write/csv.md +++ b/website/docs/sheet/write/csv.md @@ -3,6 +3,23 @@ id: 'csv' title: 'CSV' --- + + # Writing CSV Files This chapter introduces how to use Fesod to write custom CSV files. diff --git a/website/docs/sheet/write/extra.md b/website/docs/sheet/write/extra.md index a3ee9756e..0a4759d4c 100644 --- a/website/docs/sheet/write/extra.md +++ b/website/docs/sheet/write/extra.md @@ -3,6 +3,23 @@ id: 'extra' title: 'Extra' --- + + # Extra Information This chapter introduces how to write extra information such as comments, hyperlinks, formulas, merged cells, etc. diff --git a/website/docs/sheet/write/format.md b/website/docs/sheet/write/format.md index 4eb045210..e0548b1a4 100644 --- a/website/docs/sheet/write/format.md +++ b/website/docs/sheet/write/format.md @@ -3,6 +3,23 @@ id: 'format' title: 'Format' --- + + # Formatting This chapter introduces data formatting when writing data. diff --git a/website/docs/sheet/write/head.md b/website/docs/sheet/write/head.md index a19cea093..83a96ea57 100644 --- a/website/docs/sheet/write/head.md +++ b/website/docs/sheet/write/head.md @@ -3,6 +3,23 @@ id: 'head' title: 'Head' --- + + # Headers This chapter introduces how to write header data in spreadsheet. diff --git a/website/docs/sheet/write/image.md b/website/docs/sheet/write/image.md index 6e40bd0f9..c8c3b37ae 100644 --- a/website/docs/sheet/write/image.md +++ b/website/docs/sheet/write/image.md @@ -3,6 +3,23 @@ id: 'image' title: 'Image' --- + + # Images This chapter introduces how to export files containing images. diff --git a/website/docs/sheet/write/pojo.md b/website/docs/sheet/write/pojo.md index 841b2a1e5..0eb28f42c 100644 --- a/website/docs/sheet/write/pojo.md +++ b/website/docs/sheet/write/pojo.md @@ -3,6 +3,23 @@ id: 'pojo' title: 'POJO' --- + + # POJO This chapter introduces how to write data by configuring POJO classes. diff --git a/website/docs/sheet/write/sheet.md b/website/docs/sheet/write/sheet.md index 72c55e379..390efc8c4 100644 --- a/website/docs/sheet/write/sheet.md +++ b/website/docs/sheet/write/sheet.md @@ -3,6 +3,23 @@ id: 'sheet' title: 'Sheet' --- + + # Sheet This chapter introduces how to configure Sheets to write data. diff --git a/website/docs/sheet/write/simple.md b/website/docs/sheet/write/simple.md index 5e80fad20..504ab304b 100644 --- a/website/docs/sheet/write/simple.md +++ b/website/docs/sheet/write/simple.md @@ -3,6 +3,23 @@ id: 'simple' title: 'Simple' --- + + # Simple Writing This chapter introduces how to use Fesod to perform simple spreadsheet writing operations. diff --git a/website/docs/sheet/write/spring.md b/website/docs/sheet/write/spring.md index 3f5097354..f489510da 100644 --- a/website/docs/sheet/write/spring.md +++ b/website/docs/sheet/write/spring.md @@ -3,6 +3,23 @@ id: 'spring' title: 'Spring' --- + + # Spring Integration Guide This chapter introduces how to integrate and use Fesod in the Spring framework to generate spreadsheet files. diff --git a/website/docs/sheet/write/style.md b/website/docs/sheet/write/style.md index 8a4c1c5e7..3b4a6de7d 100644 --- a/website/docs/sheet/write/style.md +++ b/website/docs/sheet/write/style.md @@ -3,6 +3,23 @@ id: 'style' title: 'Style' --- + + # Style This chapter introduces style settings when writing data. diff --git a/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/committer/onboarding.md b/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/committer/onboarding.md index ccdb7a433..5f181d081 100644 --- a/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/committer/onboarding.md +++ b/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/committer/onboarding.md @@ -1,5 +1,5 @@ --- -id: 'committer-onboarding' +id: 'onboarding' title: 'Committer 须知' --- diff --git a/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/index.md b/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/index.md index cae7b6e9c..7feb398d4 100644 --- a/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/index.md +++ b/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/index.md @@ -1,5 +1,5 @@ --- -id: 'community' +id: 'index' title: '加入社区' --- diff --git a/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/pmc/onboarding.md b/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/pmc/onboarding.md index f7e22db4b..8cbd95ef3 100644 --- a/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/pmc/onboarding.md +++ b/website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/pmc/onboarding.md @@ -1,5 +1,5 @@ --- -id: 'pmc-onboarding' +id: 'onboarding' title: 'PPMC 成员须知' --- diff --git a/website/sidebarsCommunity.js b/website/sidebarsCommunity.js index 7380f6411..713dc2017 100644 --- a/website/sidebarsCommunity.js +++ b/website/sidebarsCommunity.js @@ -20,7 +20,7 @@ const sidebarsCommunity = { community: [ { - id: "community", + id: "index", type: "doc", }, { @@ -52,7 +52,7 @@ const sidebarsCommunity = { items: [ 'committer/become-committer', 'committer/icla', - 'committer/committer-onboarding', + 'committer/onboarding', ] }, { @@ -60,7 +60,7 @@ const sidebarsCommunity = { label: 'PPMC Members', items: [ 'pmc/become-pmc-member', - 'pmc/pmc-onboarding', + 'pmc/onboarding', 'pmc/nominate-committer', ] },