From eaa23f8299aa086954a80f308a79ddf2f427cf7f Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Wed, 22 Mar 2023 07:09:56 -0400 Subject: [PATCH 1/3] Minor: Document docs build process --- docs/README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index cde904857f15..eecd52b79fe7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -47,18 +47,24 @@ Preview the site on Linux by running this command. firefox build/html/index.html ``` +## Making Changes + +To make changes to the docs, simply make a Pull Request with your +proposed changes as normal. When the PR is merged the docs will be +automatically updated. + + ## Release Process -The documentation is served through the -[arrow-site](https://github.com/apache/arrow-site/) repo. To release a new -version of the docs, follow these steps: +This documentation is hosted at https://arrow.apache.org/datafusion/ -1. Run `./build.sh` inside `docs` folder to generate the docs website inside the `build/html` folder. -2. Clone the arrow-site repo -3. Checkout to the `asf-site` branch (NOT `master`) -4. Copy build artifacts into `arrow-site` repo's `datafusion` folder with a command such as +When the PR is merged to the `main` branch of the DataFusion +repository, a [github workflow](https://github.com/apache/arrow-datafusion/blob/main/.github/workflows/docs.yaml) which: -- `cp -rT ./build/html/ ../../arrow-site/datafusion/` (doesn't work on mac) -- `rsync -avzr ./build/html/ ../../arrow-site/datafusion/` +1. Builds the html content +2. Pushes the html content to the `asf-branch`[asf-site](https://github.com/apache/arrow-datafusion/tree/asf-site) branch in this repostitory. -5. Commit changes in `arrow-site` and send a PR. +The Apache Software Foundation provides https://arrow.apache.org/, +which serves content based on the configuration in +[.asf.yaml](https://github.com/apache/arrow-datafusion/blob/main/.asf.yaml), +which specifies the target as https://arrow.apache.org/datafusion/. From 8d524cc05d5bf8496a0c123d4b77149d0abc3451 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Wed, 22 Mar 2023 07:10:40 -0400 Subject: [PATCH 2/3] prettier --- docs/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index eecd52b79fe7..55643459cb6f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -53,7 +53,6 @@ To make changes to the docs, simply make a Pull Request with your proposed changes as normal. When the PR is merged the docs will be automatically updated. - ## Release Process This documentation is hosted at https://arrow.apache.org/datafusion/ From d42ef4be63efaa42dea48d97e06fd4351e127881 Mon Sep 17 00:00:00 2001 From: Sutou Kouhei Date: Thu, 23 Mar 2023 08:40:28 +0900 Subject: [PATCH 3/3] Fix a typo --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 55643459cb6f..8b55e8756e19 100644 --- a/docs/README.md +++ b/docs/README.md @@ -61,7 +61,7 @@ When the PR is merged to the `main` branch of the DataFusion repository, a [github workflow](https://github.com/apache/arrow-datafusion/blob/main/.github/workflows/docs.yaml) which: 1. Builds the html content -2. Pushes the html content to the `asf-branch`[asf-site](https://github.com/apache/arrow-datafusion/tree/asf-site) branch in this repostitory. +2. Pushes the html content to the [`asf-site`](https://github.com/apache/arrow-datafusion/tree/asf-site) branch in this repository. The Apache Software Foundation provides https://arrow.apache.org/, which serves content based on the configuration in