Skip to content

GitHub configuration, Documentation and Website Cleanup#185

Merged
tuhaihe merged 8 commits into
apache:mainfrom
tuhaihe:cleanup_20241128
Dec 2, 2024
Merged

GitHub configuration, Documentation and Website Cleanup#185
tuhaihe merged 8 commits into
apache:mainfrom
tuhaihe:cleanup_20241128

Conversation

@tuhaihe
Copy link
Copy Markdown
Member

@tuhaihe tuhaihe commented Nov 28, 2024

closes: #ISSUE_Number


Change logs

This PR focuses on cleanup tasks for GitHub configuration, documentation, and website files, including the following updates:

  1. GitHub Configuration
  • Updated the project name and links in key GitHub configuration files, including: .asf.yaml, PR template, Workflows, .gitmessage and README.md.
  1. Documentation Updates
  • Updated Docusaurus configuration settings.
  • Fixed broken anchor links in the documentation to reduce build warnings.
  1. Website Changes
  • Removed Chinese translation support for website pages (community/, contribute/, support/, bootcamp/), while preserving Chinese translations for documentation.
  • Removed redundant files (coc.md and security.md) in favor of ASF policy documents.
  • Updated outdated links and replaced old project names across various pages (Bootcamp, Community, Contribute, Support).

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:

  • Make sure that your Pull Request has a clear title and commit message. You can take the Git commit template as a reference.
  • Sign the Contributor License Agreement as prompted for your first-time contribution (One-time setup).
  • Learn the code contribution and doc contribution guides for better collaboration.
  • Make sure that your changes deployment preview is successful.
  • List your communications in the GitHub Issues or Discussions (if has or needed).
  • Feel free to ask for the @cloudberrydb/doc team or other people to help review and approve.

@tuhaihe tuhaihe requested a review from edespino November 28, 2024 08:52
Comment thread src/consts/homeContent.tsx
Comment thread src/consts/community.tsx
@edespino
Copy link
Copy Markdown
Contributor

  • You have typos in your commit messages.
  • To help reviewers, you might want to consider adding some of the details in the commits to the Title and Body of this PR. Something like:

Documentation and Website Cleanup

This PR includes several cleanup tasks for documentation and website files:

  1. Documentation Updates:

    • Updated project name and links in GitHub files (.asf.yaml, PR template, workflows, README)
    • Fixed broken anchor links in documentation
    • Updated docusaurus configuration
  2. Website Changes:

    • Removed i18n/zh support for website pages (while retaining Chinese translations for documentation)
    • Renamed and cleaned unnecessary pages (Bootcamp, Community, Contribute, Support)
    • Removed redundant files (coc.md, security.md) in favor of ASF policy documents

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.

Copy link
Copy Markdown
Contributor

@edespino edespino left a comment

Choose a reason for hiding this comment

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

  1. The Footer Security link generates a 404 because you removed the security.md.
  2. The is also another Security link 404 on how-to-contribute page.
  3. The output from npm run build is generating more warnings than it did in the past.
  4. Shouldn't docusaurus catch the 404 errors?
  5. I used linkcheck to validate the site running locally. For your reference, attached you will find its output:
    linkcheck.txt

@tuhaihe
Copy link
Copy Markdown
Member Author

tuhaihe commented Nov 29, 2024

The output from npm run build is generating more warnings than it did in the past.

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.

@tuhaihe
Copy link
Copy Markdown
Member Author

tuhaihe commented Nov 29, 2024

Now running the linkcheck and returns:

▶ ~/Downloads/linkcheck/linkcheck --skip-file skip-urls.txt http://localhost:3000 --no-check-anchors
Perfect. Checked 63880 links, 382 destination URLs (1152 ignored). 

For the missing anchor warnings, have created one issue #188. Some of the anchors are right, but cannot be directed to the right place.

@tuhaihe
Copy link
Copy Markdown
Member Author

tuhaihe commented Nov 29, 2024

  1. The Footer Security link generates a 404 because you removed the security.md.
  2. The is also another Security link 404 on how-to-contribute page.

You have typos in your commit messages.

They should be fixed.

@tuhaihe tuhaihe changed the title Cleanup the website source code GitHub configuration, Documentation and Website Cleanup Dec 2, 2024
@edespino edespino self-requested a review December 2, 2024 07:13
Copy link
Copy Markdown
Contributor

@edespino edespino left a comment

Choose a reason for hiding this comment

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

+1 - Thank you.

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.
@tuhaihe tuhaihe merged commit 93aadc6 into apache:main Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants