GitHub configuration, Documentation and Website Cleanup#185
Conversation
Documentation and Website Cleanup This PR includes several cleanup tasks for documentation and website files:
These changes streamline our documentation and website maintenance while ensuring all links and references are up to date. Note: The Chinese translations for documentation pages are preserved, but website pages will be English-only due to maintenance resource constraints. |
There was a problem hiding this comment.
- The Footer Security link generates a 404 because you removed the security.md.
- The is also another Security link 404 on how-to-contribute page.
- The output from npm run build is generating more warnings than it did in the past.
- Shouldn't docusaurus catch the 404 errors?
- I used linkcheck to validate the site running locally. For your reference, attached you will find its output:
linkcheck.txt
3dcb7a3 to
243d916
Compare
Yes, most of the issues occurred in the docs/ directory. I would like to collaborate with our documentation contributors to address them in a new PR for these warnings. |
|
Now running the For the |
They should be fixed. |
243d916 to
7459963
Compare
These changes are in the following files: * .asf.yaml * .github/pull_request_template.md * .github/workflows/publish-cloudberry-site.yml * .gitmessage * README.md
Cuttently, we lack the resources to maintain multiple language versions of the website pages. So remove the Chinese translations for them, but retaining Chinese translations for the documentation pages.
Update the links and project name on the following related pages: * Bootcamp * Community * Contribute * Support At the same time, remove the files coc.md and security.md from site as we use the ASF policy documents.
Rename the old name to Apache Cloudberry and remove the zh support for the src/community page.
7459963 to
4dc81f4
Compare
closes: #ISSUE_Number
Change logs
This PR focuses on cleanup tasks for GitHub configuration, documentation, and website files, including the following updates:
.asf.yaml, PR template, Workflows,.gitmessageand README.md.Note: While the documentation pages still support Chinese translations, website pages will now be English-only due to limited maintenance resources.
Contributor's checklist
Here are some reminders before you submit your pull request: