chore: update everything

Signed-off-by: tison <[email protected]>
apache · Jan 22, 2025 · 6b47cea · 6b47cea
1 parent ff90ff6
commit 6b47cea
Show file tree

Hide file tree

Showing 8 changed files with 9,069 additions and 6,546 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -37,7 +37,7 @@ jobs:
       - name: Build javadoc
         run: ./mvnw install javadoc:aggregate -DskipTests
       - name: Upload javadoc
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: javadoc
           path: ./target/site/apidocs
@@ -48,7 +48,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Download javadoc
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: javadoc
           path: ./static/apidocs

diff --git a/README.md b/README.md
@@ -4,26 +4,31 @@ This project keeps all sources used for building the Apache Curator official web
 
 ## Prerequisite
 
-The Apache Curator website is powered by [Docusaurus 2](https://docusaurus.io/) and is built with Node 19 and Yarn 3. Check the [deployment workflow](.github/workflows/deploy.yml) for concrete requirements and instructions.
+The Apache Curator website is powered by [Docusaurus 2](https://docusaurus.io/) and is built with Node 19 and the latest pnpm. Check the [deployment workflow](.github/workflows/deploy.yml) for concrete requirements and instructions.
 
 ## Installation
 
 ```shell
-yarn
+pnpm install
 ```
 
 ## Local Development
 
 ```shell
-yarn start
+pnpm start
 ```
 
 This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.
 
 ## Build
 
 ```shell
-yarn build
+pnpm build
 ```
 
 This command generates static content into the `build` directory and can be served using any static content hosting service.
+
+## Contact information
+
+* Submit [an issue](https://github.com/apache/curator/issues/new) on the [main apache/curator repo](http://github.com/apache/curator)
+* Subscribe to the [email protected] mailing list and start a discussion.
diff --git a/community/index.md b/community/index.md
@@ -15,7 +15,7 @@ You can:
 ## Mailing list
 
 | Name                       | Desc                            | Subscribe                                                | Unsubscribe                                                  | Post                                   | Archive                                                                  |
-|----------------------------|---------------------------------|----------------------------------------------------------|--------------------------------------------------------------|----------------------------------------|--------------------------------------------------------------------------|
+| -------------------------- | ------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------- | ------------------------------------------------------------------------ |
 | [email protected]    | Usage issues and questions      | [Subscribe](mailto:[email protected])    | [Unsubscribe](mailto:[email protected])    | [Post](mailto:[email protected]) | [Archive](https://lists.apache.org/[email protected])    |
 | [email protected]     | Development related discussions | [Subscribe](mailto:[email protected])     | [Unsubscribe](mailto:[email protected])     | [Post](mailto:[email protected])  | [Archive](https://lists.apache.org/[email protected])     |
 | [email protected] | All commits to our repositories | [Subscribe](mailto:[email protected]) | [Unsubscribe](mailto:[email protected]) | Read only list                         | [Archive](https://lists.apache.org/[email protected]) |
@@ -42,9 +42,7 @@ If you email us with a code snippet, make sure that:
 
 ## Issue tracker
 
-We use JIRA to track all code related issues: https://issues.apache.org/jira/browse/CURATOR
-
-You must have a [JIRA account](https://selfserve.apache.org/jira-account.html) in order to log cases and issues.
+We use GitHub Issues to track all code related issues: https://github.com/apache/curator/issues
 
 ### Bug reports
 

diff --git a/community/new-committers.md b/community/new-committers.md
@@ -111,7 +111,7 @@ Curator loosely uses [GitHub Flow](http://scottchacon.com/2011/08/31/github-flow
 
 * Anything in the master branch is deployable
 * The upcoming release is always "master"
-* To work on something new, create a descriptively named branch off of the upcoming release - usually the ID of the Jira issue (e.g. CURATOR-16)
+* To work on something new, create a descriptively named branch off of the upcoming release - usually the ID of the GitHub issue (e.g. CURATOR-16)
   * Commit to that branch locally and regularly push your work to the same named branch on the server
   * When you need feedback or help, or you think the branch is ready for merging, send an email on [email protected] and ask for the branch to be reviewed
   * After someone else has reviewed and signed off on the feature, merge it into "master"
@@ -148,7 +148,7 @@ Make sure you choose an appropriate version for each release. The Maven build wi
 
 Curator's source is mirrored on GitHub at: https://github.com/apache/curator. Non-committers are [asked to fork this repository and submit pull requests](submitting-pull-requests.md) (PR) for changes. When a PR is received, a Curator committer can test and possibly merge it by:
 
-* Create a branch for the PR: `git checkout -b <branch name>` - the branch name is usually the JIRA ID of the issue
+* Create a branch for the PR: `git checkout -b <branch name>` - the branch name is usually the ID of the GitHub issue
 * Pull the changes from the PR: `git pull https://github.com/<users-name>/curator.git <branch>` (or you can use `gh pr checkout <pr-number>` with [GitHub CLI](https://cli.github.com/)).
 * Test, updated, etc. the change. Periodically push the change to the main repo. For the initial push: `git push -u origin <branch name>`
 * If the change is accepted, merge it into the master branch and push the master branch. This will automatically close the GitHub PR. NOTE: Please use `git merge --squash` as this makes it easier to read the history and do cherry-pick.

diff --git a/community/submitting-pull-requests.md b/community/submitting-pull-requests.md
@@ -8,12 +8,12 @@ Curator also uses Apache's GitHub mirroring. All source code/bug fix submissions
 
 [Create your Pull Request](https://help.github.com/articles/creating-a-pull-request) against the latest revision of the files by forking the mirrored project at https://github.com/apache/curator (keep your fork in sync from then on).
 
-You must also create an issue in [Curator's Issue Tracker](https://issues.apache.org/jira/browse/CURATOR) (reference the Pull Request in the issue) and create a git branch with the same name as the Issue. All discussion, comments, etc. regarding the Pull Request should be in the Issue Tracker and/or GitHub and not by email.
+You must also create an issue in [Curator's Issue Tracker](https://github.com/apache/curator/issues) (reference the Pull Request in the issue) and create a git branch with the same name as the Issue. All discussion, comments, etc. regarding the Pull Request should be in the Issue Tracker and/or GitHub and not by email.
 
 * Fork the Curator project from GitHub
-* Create a branch with the same name as the JIRA Issue number (e.g. CURATOR-1234) in your fork and push it to GitHub
-* Create a Pull Request in GitHub. The name of the Pull Request should be in the form: `[CURATOR-XXX]` Summary of the Issue
-* The Apache infrastructure tools will automatically add a reference to your PR in the JIRA Issue
+* Create a branch with the same name as the GitHub Issue number (e.g. CURATOR-1234) in your fork and push it to GitHub
+* Create a Pull Request in GitHub. The name of the Pull Request should be in the form: `[CURATOR-XXX] Summary of the Issue`
+* The Pull Request should include a description with the issue number associated.
 
 ## Apache Contribution Guide
 
@@ -25,7 +25,6 @@ Curator uses the following tools and libraries:
 
 * Java 8
 * [Maven](http://maven.apache.org/)
-* [Jira](https://www.atlassian.com/software/jira)
 * [TestNG](http://testng.org/doc/index.html)
 * [SLF4J](http://www.slf4j.org/)
 * [Google Guava](https://code.google.com/p/guava-libraries/)
@@ -34,7 +33,7 @@ Curator uses the following tools and libraries:
 
 * Use spaces not tabs.
 * Match the style of the Curator files. Any patches will be re-formatted to match Curator style.
-* There must be a JIRA Issue created for your change.
+* There must be a GitHub Issue created for your change.
 * Create a git branch with the same name as the Issue.
 * All submissions must have TestNG tests.
 * All submissions must have proper Apache license headers. Run the following command to make sure all files have headers: `docker run --rm -v $(pwd):/github/workspace ghcr.io/korandoru/hawkeye-native:v3 format`.

diff --git a/docusaurus.config.js → docusaurus.config.ts b/docusaurus.config.js → docusaurus.config.ts
@@ -1,8 +1,7 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+import { themes as prismThemes } from 'prism-react-renderer';
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -40,7 +39,7 @@ const config = {
     ],
 
     themeConfig:
-    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+        /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
         ({
             image: 'img/curator-highres.png',
             colorMode: {
@@ -53,9 +52,9 @@ const config = {
                     src: 'img/curator-logo.svg',
                 },
                 items: [
-                    {type: 'doc', docId: 'about', position: 'right', label: 'Documentation'},
-                    {type: 'doc', docId: 'community', position: 'right', label: 'Community', docsPluginId: 'community'},
-                    {to: '/download', label: 'Download', position: 'right'},
+                    { type: 'doc', docId: 'about', position: 'right', label: 'Documentation' },
+                    { type: 'doc', docId: 'community', position: 'right', label: 'Community', docsPluginId: 'community' },
+                    { to: '/download', label: 'Download', position: 'right' },
                     // FIXME - uncomment once we write the first blog
                     // {to: '/blog', label: 'Blog', position: 'right'},
                     {
@@ -64,19 +63,19 @@ const config = {
                         className: 'header-github-link',
                         'aria-label': 'GitHub repository',
                     },
-                    {type: 'search', position: 'right'},
+                    { type: 'search', position: 'right' },
                     {
                         type: 'dropdown',
                         label: 'ASF',
                         position: 'right',
                         items: [
-                            {label: 'Foundation', to: 'https://www.apache.org/'},
-                            {label: 'License', to: 'https://www.apache.org/licenses/'},
-                            {label: 'Events', to: 'https://www.apache.org/events/current-event.html'},
-                            {label: 'Security', to: 'https://www.apache.org/security/'},
-                            {label: 'Sponsorship', to: 'https://www.apache.org/foundation/sponsorship.html'},
-                            {label: 'Privacy', to: 'https://privacy.apache.org/policies/privacy-policy-public.html'},
-                            {label: 'Thanks', to: 'https://www.apache.org/foundation/thanks.html'}
+                            { label: 'Foundation', to: 'https://www.apache.org/' },
+                            { label: 'License', to: 'https://www.apache.org/licenses/' },
+                            { label: 'Events', to: 'https://www.apache.org/events/current-event.html' },
+                            { label: 'Security', to: 'https://www.apache.org/security/' },
+                            { label: 'Sponsorship', to: 'https://www.apache.org/foundation/sponsorship.html' },
+                            { label: 'Privacy', to: 'https://privacy.apache.org/policies/privacy-policy-public.html' },
+                            { label: 'Thanks', to: 'https://www.apache.org/foundation/thanks.html' }
                         ],
                     },
                 ],
@@ -92,8 +91,8 @@ const config = {
                 copyright: 'Apache Curator, the Apache feather logo, and the Apache Curator project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.',
             },
             prism: {
-                theme: lightCodeTheme,
-                darkTheme: darkCodeTheme,
+                theme: prismThemes.github,
+                darkTheme: prismThemes.dracula,
                 additionalLanguages: [
                     'groovy',
                     'java',
@@ -109,7 +108,7 @@ const config = {
                 id: 'community',
                 path: 'community',
                 routeBasePath: 'community',
-                sidebarPath: require.resolve('./sidebarsCommunity.js'),
+                sidebarPath: './sidebarsCommunity.js',
                 editUrl: 'https://github.com/apache/curator-site/tree/main/',
             },
         ],

diff --git a/package.json b/package.json
@@ -15,20 +15,20 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.1",
-    "@docusaurus/preset-classic": "2.4.1",
-    "@easyops-cn/docusaurus-search-local": "^0.26.1",
-    "@mdx-js/react": "^1.6.22",
-    "clsx": "^1.2.1",
-    "docusaurus-plugin-image-zoom": "^0.1.1",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "@docusaurus/core": "3.7.0",
+    "@docusaurus/preset-classic": "3.7.0",
+    "@easyops-cn/docusaurus-search-local": "^0.48.4",
+    "@mdx-js/react": "^3.1.0",
+    "clsx": "^2.1.1",
+    "docusaurus-plugin-image-zoom": "^2.0.0",
+    "prism-react-renderer": "^2.4.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.1",
-    "@tsconfig/docusaurus": "^1.0.5",
-    "typescript": "^4.7.4"
+    "@docusaurus/module-type-aliases": "3.7.0",
+    "@tsconfig/docusaurus": "^2.0.3",
+    "typescript": "^5.7.3"
   },
   "browserslist": {
     "production": [
@@ -45,4 +45,4 @@
   "engines": {
     "node": ">=16.14"
   }
-}
+}