Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update .asf.yaml to publish docs to datafusion.apache.org #10190

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Update .asf.yaml to publish docs to datafusion.apache.org #10190

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
941cff1
Update .asf.yaml to publish to root
phillipleblanc Apr 23, 2024
07113c4
Update website to have top-level ASF links
phillipleblanc Apr 23, 2024
70ff7b9
Merge branch 'main' into phillip/240423-update-asf-yaml-2
phillipleblanc Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .asf.yaml
View file
Open in desktop
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/
Copy link
Member

@viirya viirya Apr 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be https://datafusion.apache.org/datafusion/?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://datafusion.apache.org/ will give you:

Screenshot 2024-04-22 at 8 19 35 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After this change it should start publishing to https://datafusion.apache.org without needing the subdirectory 🤞

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
View file
Open in desktop
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
View file
Open in desktop
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
Loading