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.

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

doc: deploy crate docs to GitHub pages #4436

Merged
merged 3 commits into from
Jun 26, 2023
Merged

doc: deploy crate docs to GitHub pages #4436

merged 3 commits into from
Jun 26, 2023

Conversation

xxchan
Copy link
Contributor

@xxchan xxchan commented Jun 19, 2023

Which issue does this PR close?

Closes #.

Rationale for this change

arrow-rs has so many crates. We often need to browse the doc for more than one crates. But on doc.rs, we can't go to other crates conveniently.

image

Deploying to GitHub pages can improve the situation

image

See it on my fork: https://xxchan.github.io/arrow-rs

https://github.com/xxchan/arrow-rs/actions/workflows/docs.yml

What changes are included in this PR?

Are there any user-facing changes?

@github-actions github-actions bot added arrow Changes to the arrow crate parquet Changes to the parquet crate labels Jun 19, 2023
@alamb
Copy link
Contributor

alamb commented Jun 20, 2023

Another strategy that is used for other arrow projects is to publish the apache site (e.g. https://arrow.apache.org/datafusion/)

This is described in https://github.com/apache/arrow-datafusion/tree/main/docs#release-process

I would be happy to help figure out how to make the process work here as well

@alamb
Copy link
Contributor

alamb commented Jun 20, 2023

Thank you @xxchan -- this is very helpful.

@alamb
Copy link
Contributor

alamb commented Jun 26, 2023

Let's merge this and see how it works

@alamb alamb merged commit 9c0cae5 into apache:master Jun 26, 2023
@xxchan
Copy link
Contributor Author

xxchan commented Jun 26, 2023

Oops

image

@xxchan
Copy link
Contributor Author

xxchan commented Jun 26, 2023

Maybe we need to update asf.yaml

@alamb
Copy link
Contributor

alamb commented Jun 26, 2023

Yes, I think we need to do the same thing as in DataFusion

@xxchan would it be possible for you to look into doing so? Aka what is described in #4436 (comment)?

If you don't have time that is also fine, I can revert this change and we can work on it when we do have time

@alamb alamb added the documentation Improvements or additions to documentation label Jun 26, 2023
@xxchan
Copy link
Contributor Author

xxchan commented Jun 26, 2023 via email

@alamb
Copy link
Contributor

alamb commented Jun 26, 2023

@martin-g did the work in DataFusion via apache/datafusion#5670 -- maybe we could follow the same model here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate documentation Improvements or additions to documentation parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants