This is an automated email from the ASF dual-hosted git repository.
jiekaichang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/main by this push:
new 2541c6803 [Website][Docs] Redirect website & unified download Page
(#1119)
2541c6803 is described below
commit 2541c6803e551975455fd52a0d62fe72a94d687e
Author: Jie-Kai Chang <[email protected]>
AuthorDate: Thu Mar 5 14:28:41 2026 +0800
[Website][Docs] Redirect website & unified download Page (#1119)
Signed-off-by: 400Ping <[email protected]>
---
docs/download/index.md | 42 ---------------
docs/download/quickstart.md | 58 --------------------
docs/index.md | 2 +-
docs/qumat/getting-started.md | 63 +++++++++++++++-------
website/docusaurus.config.ts | 10 ++--
website/sidebars.ts | 7 ---
website/src/pages/download.tsx | 2 +-
website/src/pages/downloads.tsx | 53 +-----------------
website/src/pages/index.tsx | 2 +-
website/static/download/downloads.html | 8 +--
.../versioned_docs/version-0.5/download/index.md | 42 ---------------
.../version-0.5/download/quickstart.md | 58 --------------------
website/versioned_docs/version-0.5/index.md | 2 +-
.../version-0.5/qumat/getting-started.md | 60 ++++++++++++++-------
.../versioned_sidebars/version-0.5-sidebars.json | 12 -----
15 files changed, 102 insertions(+), 319 deletions(-)
diff --git a/docs/download/index.md b/docs/download/index.md
deleted file mode 100644
index dfcc3d7b4..000000000
--- a/docs/download/index.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
-title: Install
-sidebar_label: Install
----
-
-# Install
-
-```bash
-pip install qumat
-```
-
-To install with QDP (Quantum Data Plane) support:
-
-```bash
-pip install qumat[qdp]
-```
-
-## From Source
-
-```bash
-git clone https://github.com/apache/mahout.git
-cd mahout
-pip install uv
-uv sync # Core Qumat
-uv sync --extra qdp # With QDP (requires CUDA GPU)
-```
-
-## Apache Release
-
-Official source releases are available at
[apache.org/dist/mahout](http://www.apache.org/dist/mahout).
-
-To verify the integrity of a downloaded release:
-
-```bash
-gpg --import KEYS
-gpg --verify mahout-qumat-0.5.zip.asc mahout-qumat-0.5.zip
-```
-
-## Links
-
-- [PyPI](https://pypi.org/project/qumat/)
-- [Apache SVN](http://www.apache.org/dist/mahout)
diff --git a/docs/download/quickstart.md b/docs/download/quickstart.md
deleted file mode 100644
index f4b8c19ac..000000000
--- a/docs/download/quickstart.md
+++ /dev/null
@@ -1,58 +0,0 @@
----
-title: Quickstart
-sidebar_label: Quickstart
----
-
-<!--
- 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.
--->
-
-# Qumat Quickstart
-
-## Installation
-
-Install Qumat using pip:
-
-```bash
-pip install qumat
-```
-
-## Basic Usage
-
-```python
-from qumat import QumatCircuit
-
-# Create a simple quantum circuit
-circuit = QumatCircuit(2)
-circuit.h(0) # Hadamard gate on qubit 0
-circuit.cx(0, 1) # CNOT gate
-
-# Run the circuit
-result = circuit.run()
-print(result)
-```
-
-## Next Steps
-
-- [Getting Started with Qumat](../getting-started-with-qumat)
-- [Basic Gates](../basic-gates)
-- [API Reference](../api)
-
-## Legacy Mahout MapReduce
-
-:::note
-The legacy Mahout MapReduce functionality is deprecated. For current quantum
computing features, see the [Qumat documentation](../qumat).
-:::
diff --git a/docs/index.md b/docs/index.md
index bb2dc9ec1..3feed5e6a 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -14,7 +14,7 @@ anywhere.'
## Documentation
### Getting Started
-- [Getting Started with QuMat](./qumat/getting-started) - Introduction and
setup guide
+- [Getting Started with QuMat](/docs/qumat/getting-started) - Introduction and
setup guide
### Core Concepts
- [Basic Gates](./qumat/basic-gates) - Introduction to fundamental quantum
gates (NOT, Hadamard, CNOT, Toffoli, SWAP, Pauli gates, CSWAP, U gate)
diff --git a/docs/qumat/getting-started.md b/docs/qumat/getting-started.md
index 000d1044a..643505b39 100644
--- a/docs/qumat/getting-started.md
+++ b/docs/qumat/getting-started.md
@@ -1,21 +1,29 @@
-# Getting Started with Qumat
+---
+title: Getting Started
+---
-## Basic Installation
+# Getting Started with Qumat
-Getting started with Qumat is easy, thanks to the simplified installation
process. You can install Qumat by choosing one of the following methods.
+## Installation
-### Method 1: Install from PyPI (Recommended)
+Install Qumat from PyPI:
```bash
pip install qumat
```
-### Method 2: Install from Source (Development)
+Install with QDP (Quantum Data Plane) support:
+
+```bash
+pip install qumat[qdp]
+```
+
+## From Source (Development)
-For development or to get the latest changes, use
[uv](https://docs.astral.sh/uv/):
+For development or the latest changes, use [uv](https://docs.astral.sh/uv/):
```bash
-git clone https://github.com/apache/mahout
+git clone https://github.com/apache/mahout.git
cd mahout
pip install uv
uv sync # Core Qumat
@@ -26,25 +34,42 @@ uv sync --extra qdp # With QDP (requires NVIDIA GPU
+ CUDA)
The project uses `uv` to handle dependency overrides required for Python 3.10+
compatibility with some backend dependencies.
:::
-## Dependencies
+## Basic Usage
-Prior to installation, ensure Python 3.10-3.12 is installed. Dependencies such
as Qiskit, Cirq, and Amazon Braket SDK will be managed automatically.
+```python
+from qumat import QumatCircuit
-## Examples
+circuit = QumatCircuit(2)
+circuit.h(0)
+circuit.cx(0, 1)
+result = circuit.run()
+print(result)
+```
+
+## Dependencies
-Refer to the example notebooks in the `examples/` directory at the repository
root for practical implementations:
+Prior to installation, ensure Python 3.10-3.12 is installed. Dependencies such
as Qiskit, Cirq, and Amazon Braket SDK are managed automatically.
-- `examples/Simple_Example.ipynb` - Basic quantum circuit example
-- `examples/Optimization_Example.ipynb` - Optimization with parameterized
circuits
+## Apache Release
-## Building the Website
+Official source releases are available at
[apache.org/dist/mahout](http://www.apache.org/dist/mahout).
-To serve the website locally:
+To verify the integrity of a downloaded release:
```bash
-cd website
-npm install
-npm run start
+gpg --import KEYS
+gpg --verify mahout-qumat-0.5.zip.asc mahout-qumat-0.5.zip
```
-See the [website
README](https://github.com/apache/mahout/tree/main/website#readme) for more
details.
+## Examples
+
+Refer to repository examples:
+
+- `examples/Simple_Example.ipynb`
+- `examples/Optimization_Example.ipynb`
+
+## Next Steps
+
+- [Basic Gates](/docs/qumat/basic-gates)
+- [API Reference](/docs/qumat/api)
+- [QDP Getting Started](/docs/qdp/getting-started)
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
index 5ef958647..6e07117e6 100644
--- a/website/docusaurus.config.ts
+++ b/website/docusaurus.config.ts
@@ -106,9 +106,13 @@ const config: Config = {
if (existingPath === '/blog') {
return ['/news.html', '/news'];
}
- // Keep /downloads as the canonical public download entry URL.
- if (existingPath === '/downloads') {
+ // Keep /docs/qumat/getting-started as the canonical getting-started
URL.
+ if (existingPath === '/docs/qumat/getting-started') {
return [
+ '/docs/download',
+ '/docs/download/quickstart',
+ '/docs/next/download',
+ '/docs/next/download/quickstart',
];
}
return undefined;
@@ -176,7 +180,7 @@ const config: Config = {
},
// Download
{
- to: '/downloads',
+ to: '/docs/qumat/getting-started',
label: 'Download',
position: 'left',
},
diff --git a/website/sidebars.ts b/website/sidebars.ts
index 4740468c7..90ee4a873 100644
--- a/website/sidebars.ts
+++ b/website/sidebars.ts
@@ -85,13 +85,6 @@ const sidebars: SidebarsConfig = {
'learning/papers/Unleashing-the-Potential-of-LLMs-for-Quantum-Computing',
],
},
- {
- type: 'category',
- label: 'Download',
- collapsed: true,
- link: {type: 'doc', id: 'download/index'},
- items: ['download/quickstart'],
- },
{
type: 'category',
label: 'Community',
diff --git a/website/src/pages/download.tsx b/website/src/pages/download.tsx
index 097e7df2b..f321cfe51 100644
--- a/website/src/pages/download.tsx
+++ b/website/src/pages/download.tsx
@@ -2,5 +2,5 @@ import type {ReactElement} from 'react';
import {Redirect} from '@docusaurus/router';
export default function DownloadPage(): ReactElement {
- return <Redirect to="/downloads" />;
+ return <Redirect to="/docs/qumat/getting-started" />;
}
diff --git a/website/src/pages/downloads.tsx b/website/src/pages/downloads.tsx
index d5a69f639..4ed619435 100644
--- a/website/src/pages/downloads.tsx
+++ b/website/src/pages/downloads.tsx
@@ -1,55 +1,6 @@
import type {ReactElement} from 'react';
-import Layout from '@theme/Layout';
-import Heading from '@theme/Heading';
+import {Redirect} from '@docusaurus/router';
export default function DownloadsPage(): ReactElement {
- return (
- <Layout title="Downloads" description="Apache Mahout download and install
instructions">
- <main className="container margin-vert--lg">
- <Heading as="h1">Downloads</Heading>
- <p>Install Qumat from PyPI:</p>
- <pre>
- <code>pip install qumat</code>
- </pre>
- <p>Install with QDP (Quantum Data Plane) support:</p>
- <pre>
- <code>pip install qumat[qdp]</code>
- </pre>
-
- <Heading as="h2">From Source</Heading>
- <pre>
- <code>
- git clone https://github.com/apache/mahout.git{'\n'}
- cd mahout{'\n'}
- pip install uv{'\n'}
- uv sync # Core Qumat{'\n'}
- uv sync --extra qdp # With QDP (requires CUDA GPU)
- </code>
- </pre>
-
- <Heading as="h2">Apache Release</Heading>
- <p>
- Official source releases are available at{' '}
- <a
href="http://www.apache.org/dist/mahout";>apache.org/dist/mahout</a>.
- </p>
- <p>To verify the integrity of a downloaded release:</p>
- <pre>
- <code>
- gpg --import KEYS{'\n'}
- gpg --verify mahout-qumat-0.5.zip.asc mahout-qumat-0.5.zip
- </code>
- </pre>
-
- <Heading as="h2">Links</Heading>
- <ul>
- <li>
- <a href="https://pypi.org/project/qumat/";>PyPI</a>
- </li>
- <li>
- <a href="http://www.apache.org/dist/mahout";>Apache SVN</a>
- </li>
- </ul>
- </main>
- </Layout>
- );
+ return <Redirect to="/docs/qumat/getting-started" />;
}
diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx
index 2fef8f745..3c72c7753 100644
--- a/website/src/pages/index.tsx
+++ b/website/src/pages/index.tsx
@@ -58,7 +58,7 @@ function Sidebar() {
<div className={styles.cardHeader}>Qumat 0.5 Released!</div>
<div className={styles.cardBody}>
<p>Mahout's new quantum computing layer for building ML circuits on
simulators and real quantum hardware.</p>
- <Link to="/downloads">Download Qumat 0.5 →</Link>
+ <Link to="/docs/qumat/getting-started">Download Qumat 0.5 →</Link>
</div>
</div>
diff --git a/website/static/download/downloads.html
b/website/static/download/downloads.html
index f8092cdda..ce9177092 100644
--- a/website/static/download/downloads.html
+++ b/website/static/download/downloads.html
@@ -2,13 +2,13 @@
<html lang="en">
<head>
<meta charset="utf-8">
- <meta http-equiv="refresh" content="0; url=/downloads">
+ <meta http-equiv="refresh" content="0; url=/docs/qumat/getting-started">
<meta name="robots" content="noindex">
- <link rel="canonical" href="https://mahout.apache.org/downloads";>
+ <link rel="canonical"
href="https://mahout.apache.org/docs/qumat/getting-started";>
<title>Redirecting to Downloads</title>
- <script>window.location.replace('/downloads');</script>
+ <script>window.location.replace('/docs/qumat/getting-started');</script>
</head>
<body>
- <p>Redirecting to <a href="/downloads">/downloads</a>...</p>
+ <p>Redirecting to <a
href="/docs/qumat/getting-started">/docs/qumat/getting-started</a>...</p>
</body>
</html>
diff --git a/website/versioned_docs/version-0.5/download/index.md
b/website/versioned_docs/version-0.5/download/index.md
deleted file mode 100644
index dfcc3d7b4..000000000
--- a/website/versioned_docs/version-0.5/download/index.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
-title: Install
-sidebar_label: Install
----
-
-# Install
-
-```bash
-pip install qumat
-```
-
-To install with QDP (Quantum Data Plane) support:
-
-```bash
-pip install qumat[qdp]
-```
-
-## From Source
-
-```bash
-git clone https://github.com/apache/mahout.git
-cd mahout
-pip install uv
-uv sync # Core Qumat
-uv sync --extra qdp # With QDP (requires CUDA GPU)
-```
-
-## Apache Release
-
-Official source releases are available at
[apache.org/dist/mahout](http://www.apache.org/dist/mahout).
-
-To verify the integrity of a downloaded release:
-
-```bash
-gpg --import KEYS
-gpg --verify mahout-qumat-0.5.zip.asc mahout-qumat-0.5.zip
-```
-
-## Links
-
-- [PyPI](https://pypi.org/project/qumat/)
-- [Apache SVN](http://www.apache.org/dist/mahout)
diff --git a/website/versioned_docs/version-0.5/download/quickstart.md
b/website/versioned_docs/version-0.5/download/quickstart.md
deleted file mode 100644
index f4b8c19ac..000000000
--- a/website/versioned_docs/version-0.5/download/quickstart.md
+++ /dev/null
@@ -1,58 +0,0 @@
----
-title: Quickstart
-sidebar_label: Quickstart
----
-
-<!--
- 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.
--->
-
-# Qumat Quickstart
-
-## Installation
-
-Install Qumat using pip:
-
-```bash
-pip install qumat
-```
-
-## Basic Usage
-
-```python
-from qumat import QumatCircuit
-
-# Create a simple quantum circuit
-circuit = QumatCircuit(2)
-circuit.h(0) # Hadamard gate on qubit 0
-circuit.cx(0, 1) # CNOT gate
-
-# Run the circuit
-result = circuit.run()
-print(result)
-```
-
-## Next Steps
-
-- [Getting Started with Qumat](../getting-started-with-qumat)
-- [Basic Gates](../basic-gates)
-- [API Reference](../api)
-
-## Legacy Mahout MapReduce
-
-:::note
-The legacy Mahout MapReduce functionality is deprecated. For current quantum
computing features, see the [Qumat documentation](../qumat).
-:::
diff --git a/website/versioned_docs/version-0.5/index.md
b/website/versioned_docs/version-0.5/index.md
index bb2dc9ec1..3feed5e6a 100644
--- a/website/versioned_docs/version-0.5/index.md
+++ b/website/versioned_docs/version-0.5/index.md
@@ -14,7 +14,7 @@ anywhere.'
## Documentation
### Getting Started
-- [Getting Started with QuMat](./qumat/getting-started) - Introduction and
setup guide
+- [Getting Started with QuMat](/docs/qumat/getting-started) - Introduction and
setup guide
### Core Concepts
- [Basic Gates](./qumat/basic-gates) - Introduction to fundamental quantum
gates (NOT, Hadamard, CNOT, Toffoli, SWAP, Pauli gates, CSWAP, U gate)
diff --git a/website/versioned_docs/version-0.5/qumat/getting-started.md
b/website/versioned_docs/version-0.5/qumat/getting-started.md
index c438adc29..643505b39 100644
--- a/website/versioned_docs/version-0.5/qumat/getting-started.md
+++ b/website/versioned_docs/version-0.5/qumat/getting-started.md
@@ -1,24 +1,29 @@
---
title: Getting Started
---
-# Getting Started with Qumat
-## Basic Installation
+# Getting Started with Qumat
-Getting started with Qumat is easy, thanks to the simplified installation
process. You can install Qumat by choosing one of the following methods.
+## Installation
-### Method 1: Install from PyPI (Recommended)
+Install Qumat from PyPI:
```bash
pip install qumat
```
-### Method 2: Install from Source (Development)
+Install with QDP (Quantum Data Plane) support:
+
+```bash
+pip install qumat[qdp]
+```
+
+## From Source (Development)
-For development or to get the latest changes, use
[uv](https://docs.astral.sh/uv/):
+For development or the latest changes, use [uv](https://docs.astral.sh/uv/):
```bash
-git clone https://github.com/apache/mahout
+git clone https://github.com/apache/mahout.git
cd mahout
pip install uv
uv sync # Core Qumat
@@ -29,25 +34,42 @@ uv sync --extra qdp # With QDP (requires NVIDIA GPU
+ CUDA)
The project uses `uv` to handle dependency overrides required for Python 3.10+
compatibility with some backend dependencies.
:::
-## Dependencies
+## Basic Usage
-Prior to installation, ensure Python 3.10-3.12 is installed. Dependencies such
as Qiskit, Cirq, and Amazon Braket SDK will be managed automatically.
+```python
+from qumat import QumatCircuit
-## Examples
+circuit = QumatCircuit(2)
+circuit.h(0)
+circuit.cx(0, 1)
+result = circuit.run()
+print(result)
+```
+
+## Dependencies
-Refer to the example notebooks in the `examples/` directory at the repository
root for practical implementations:
+Prior to installation, ensure Python 3.10-3.12 is installed. Dependencies such
as Qiskit, Cirq, and Amazon Braket SDK are managed automatically.
-- `examples/Simple_Example.ipynb` - Basic quantum circuit example
-- `examples/Optimization_Example.ipynb` - Optimization with parameterized
circuits
+## Apache Release
-## Building the Website
+Official source releases are available at
[apache.org/dist/mahout](http://www.apache.org/dist/mahout).
-To serve the website locally:
+To verify the integrity of a downloaded release:
```bash
-cd website
-npm install
-npm run start
+gpg --import KEYS
+gpg --verify mahout-qumat-0.5.zip.asc mahout-qumat-0.5.zip
```
-See the [website
README](https://github.com/apache/mahout/tree/main/website#readme) for more
details.
+## Examples
+
+Refer to repository examples:
+
+- `examples/Simple_Example.ipynb`
+- `examples/Optimization_Example.ipynb`
+
+## Next Steps
+
+- [Basic Gates](/docs/qumat/basic-gates)
+- [API Reference](/docs/qumat/api)
+- [QDP Getting Started](/docs/qdp/getting-started)
diff --git a/website/versioned_sidebars/version-0.5-sidebars.json
b/website/versioned_sidebars/version-0.5-sidebars.json
index 5d79cd8ed..10384bf16 100644
--- a/website/versioned_sidebars/version-0.5-sidebars.json
+++ b/website/versioned_sidebars/version-0.5-sidebars.json
@@ -94,18 +94,6 @@
"learning/papers/Unleashing-the-Potential-of-LLMs-for-Quantum-Computing"
]
},
- {
- "type": "category",
- "label": "Download",
- "collapsed": true,
- "link": {
- "type": "doc",
- "id": "download/index"
- },
- "items": [
- "download/quickstart"
- ]
- },
{
"type": "category",
"label": "Community",
