From e6ff15f17c1a5553d4c23639512c625a85cd1357 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Tue, 8 Feb 2022 16:56:25 -0500 Subject: [PATCH 1/2] tweak doc publishing instructions --- docs/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 255dbe4c7c6e4..5492eed2a3f66 100644 --- a/docs/README.md +++ b/docs/README.md @@ -40,7 +40,10 @@ 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: -- Run `make html` inside `docs` folder to generate the docs website inside the `build/html` folder. -- Clone the arrow-site repo and checkout to the `asf-site` branch -- Copy build artifacts into `arrow-site` repo's `datafusion` folder: `'cp' -rT ./build/html/ ../arrow-site/datafusion/` -- Commit changes in `arrow-site` and send a PR. +1. Run `make html` 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 + * `cp -rT ./build/html/ ../../arrow-site/datafusion/` (doesn't work on mac) + * `rsync -avzr ./build/html/ ../../arrow-site/datafusion/` +5. Commit changes in `arrow-site` and send a PR. From 4c191b19ccd7c4a2d6118040f6c4d77684e72f1d Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Tue, 8 Feb 2022 17:04:49 -0500 Subject: [PATCH 2/2] prettier --- docs/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 5492eed2a3f66..d8b2f97ee8d42 100644 --- a/docs/README.md +++ b/docs/README.md @@ -44,6 +44,8 @@ version of the docs, follow these steps: 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 - * `cp -rT ./build/html/ ../../arrow-site/datafusion/` (doesn't work on mac) - * `rsync -avzr ./build/html/ ../../arrow-site/datafusion/` + +- `cp -rT ./build/html/ ../../arrow-site/datafusion/` (doesn't work on mac) +- `rsync -avzr ./build/html/ ../../arrow-site/datafusion/` + 5. Commit changes in `arrow-site` and send a PR.