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

ARROW-14496: [Docs] Create relative links for R / JS / C/Glib references in the sphinx toctree using stub pages #11601

Conversation

jorisvandenbossche
Copy link
Member

This will create dummy pages like /r/index.html which can be used for sphinx to link to, but which should not be added to the actual hosted files for the arrow site (they have to be overwritten by the index.html files of the respective proper doc builds for R, js and C/Glib).

@github-actions
Copy link

github-actions bot commented Nov 4, 2021

@github-actions
Copy link

github-actions bot commented Nov 4, 2021

⚠️ Ticket has not been started in JIRA, please click 'Start Progress'.

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

@jorisvandenbossche could you please fix the javadoc reference?

Reference (javadoc) <https://arrow.apache.org/docs/java/reference/>

at https://github.com/apache/arrow/blob/master/docs/source/java/index.rst

@jorisvandenbossche
Copy link
Member Author

Ah, yes I forgot the Java reference link. Now, we actually don't have the reference included in any of the currently hosted older versions. So fixing this link as well would actually give broken links ..

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

We need to regenerate the sphinx part for the previous versions and copy the language references back from previous site deployments, right?

@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Nov 4, 2021

The java reference is a non-sphinx part, so that's not directly related to regenerating the sphinx site for older versions.
But so I intentionally left out the java reference for older versions, because it is too big to host many versions with our current github pages approach (a bit more than 100MB for a single version). See apache/arrow-site#139

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

How many versions including the javadoc would fit in the 1GB github pages limit?

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

We can also erase the history of the asf-site branch and keep the last commit to reduce the overall repository size.

@jorisvandenbossche
Copy link
Member Author

Based on my comment in apache/arrow-site#139, adding the full content for versions 1 up to 5 would have added ~700MB. Which is already close to the limit, and within a half year / 2 more releases, we would hit the limit.
(and this is for the published pages, for which erasing git history doesn't help)

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

How about just keeping e.g. the last 5 releases?

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

@github-actions crossbow submit ubuntu-docs

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

@github-actions crossbow submit test-ubuntu-docs

@kszucs
Copy link
Member

kszucs commented Nov 4, 2021

@github-actions crossbow submit test-ubuntu-20.10-docs test-ubuntu-default-docs

@github-actions
Copy link

github-actions bot commented Nov 4, 2021

Revision: ad6e262

Submitted crossbow builds: ursacomputing/crossbow @ actions-1092

Task Status
test-ubuntu-20.10-docs Azure
test-ubuntu-default-docs Azure

Copy link
Member

@kszucs kszucs left a comment

Choose a reason for hiding this comment

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

Thanks Joris!

@kszucs kszucs closed this in a9ba3f2 Nov 4, 2021
@ursabot
Copy link

ursabot commented Nov 4, 2021

Benchmark runs are scheduled for baseline = 95e8b92 and contender = a9ba3f2. a9ba3f2 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Finished ⬇️0.0% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.13% ⬆️0.04%] ursa-thinkcentre-m75q
Supported benchmarks:
ursa-i9-9960x: langs = Python, R, JavaScript
ursa-thinkcentre-m75q: langs = C++, Java
ec2-t3-xlarge-us-east-2: cloud = True

kszucs pushed a commit that referenced this pull request Nov 4, 2021
…ces in the sphinx toctree using stub pages

This will create dummy pages like `/r/index.html` which can be used for sphinx to link to, but which should not be added to the actual hosted files for the arrow site (they have to be overwritten by the index.html files of the respective proper doc builds for R, js and C/Glib).

Closes #11601 from jorisvandenbossche/ARROW-14496-toctree-external

Authored-by: Joris Van den Bossche <[email protected]>
Signed-off-by: Krisztián Szűcs <[email protected]>
@jorisvandenbossche jorisvandenbossche deleted the ARROW-14496-toctree-external branch November 5, 2021 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants