Skip to content

Commit

Permalink
Update .asf.yaml to publish docs to datafusion.apache.org (#10190)
Browse files Browse the repository at this point in the history
* Update .asf.yaml to publish to root

* Update website to have top-level ASF links
  • Loading branch information
phillipleblanc committed Apr 23, 2024
1 parent 711239f commit da82cec
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
5 changes: 2 additions & 3 deletions .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ notifications:
jira_options: link label worklog
github:
description: "Apache DataFusion SQL Query Engine"
homepage: https://arrow.apache.org/datafusion
homepage: https://datafusion.apache.org/
labels:
- arrow
- big-data
Expand All @@ -50,7 +50,6 @@ github:
required_approving_review_count: 1

# publishes the content of the `asf-site` branch to
# https://arrow.apache.org/datafusion/
# https://datafusion.apache.org/
publish:
whoami: asf-site
subdir: datafusion
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

This folder contains the source content of the [User Guide](./source/user-guide)
and [Contributor Guide](./source/contributor-guide). These are both published to
https://arrow.apache.org/datafusion/ as part of the release process.
https://datafusion.apache.org/ as part of the release process.

## Dependencies

Expand Down Expand Up @@ -55,15 +55,15 @@ automatically updated.

## Release Process

This documentation is hosted at https://arrow.apache.org/datafusion/
This documentation is hosted at https://datafusion.apache.org/

When the PR is merged to the `main` branch of the DataFusion
repository, a [github workflow](https://github.com/apache/datafusion/blob/main/.github/workflows/docs.yaml) which:

1. Builds the html content
2. Pushes the html content to the [`asf-site`](https://github.com/apache/datafusion/tree/asf-site) branch in this repository.

The Apache Software Foundation provides https://arrow.apache.org/,
The Apache Software Foundation provides https://datafusion.apache.org/,
which serves content based on the configuration in
[.asf.yaml](https://github.com/apache/datafusion/blob/main/.asf.yaml),
which specifies the target as https://arrow.apache.org/datafusion/.
which specifies the target as https://datafusion.apache.org/.
11 changes: 11 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,17 @@ Please see the `developer’s guide`_ for contributing and `communication`_ for
.. _developer’s guide: contributor-guide/index.html#developer-s-guide
.. _communication: contributor-guide/communication.html

.. _toc.asf-links:
.. toctree::
:maxdepth: 1
:caption: ASF Links

Apache Software Foundation <https://apache.org>
License <https://www.apache.org/licenses/>
Donate <https://www.apache.org/foundation/sponsorship.html>
Thanks <https://www.apache.org/foundation/thanks.html>
Security <https://www.apache.org/security/>

.. _toc.links:
.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit da82cec

Please sign in to comment.