You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2023/03/22 11:14:30 UTC
[GitHub] [arrow-datafusion] alamb opened a new pull request, #5687: Minor: Document docs build process
alamb opened a new pull request, #5687:
URL: https://github.com/apache/arrow-datafusion/pull/5687
# Which issue does this PR close?
Related to #5500
# Rationale for this change
https://github.com/apache/arrow-datafusion/pull/5670 from @martin-g automates the build and publish of the datafusion documentation to https://arrow.apache.org/datafusion/ 🎉
# What changes are included in this PR?
Update the documentation on the release process
# Are these changes tested?
N/A
# Are there any user-facing changes?
No
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] kou merged pull request #5687: Minor: Document docs build process
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou merged PR #5687:
URL: https://github.com/apache/arrow-datafusion/pull/5687
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] kou commented on a diff in pull request #5687: Minor: Document docs build process
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #5687:
URL: https://github.com/apache/arrow-datafusion/pull/5687#discussion_r1145524734
##########
docs/README.md:
##########
@@ -47,18 +47,23 @@ 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.
Review Comment:
```suggestion
2. Pushes the html content to the [`asf-site`](https://github.com/apache/arrow-datafusion/tree/asf-site) branch in this repository.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org