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

[Docs][Website] JS docs are missing #37858

Closed
domoritz opened this issue Sep 25, 2023 · 3 comments · Fixed by #37870
Closed

[Docs][Website] JS docs are missing #37858

domoritz opened this issue Sep 25, 2023 · 3 comments · Fixed by #37870
Assignees
@raulcd
Labels
Component: Documentation Component: Website Priority: Critical Type: bug
Milestone
14.0.0

Comments

@domoritz
Copy link
Member

Describe the bug, including details regarding any error messages, version, and platform.

The JS docs at https://arrow.apache.org/docs/js/index.html are not accessible probably because of some reorganization of the website.

The docs for 12 are at https://arrow.apache.org/docs/12.0/js/index.html but https://arrow.apache.org/docs/13.0/js/index.html doesn't exist either.

Component(s)

Documentation
@domoritz domoritz mentioned this issue Sep 25, 2023
Closed
@domoritz domoritz changed the title JS docs are missing [Docs] JS docs are missing Sep 25, 2023
@domoritz domoritz changed the title [Docs] JS docs are missing [Docs][Website] JS docs are missing Sep 25, 2023
@kou
Copy link
Member

kou commented Sep 25, 2023

Oh, @raulcd could you take a look at this?
docs.tar.gz in https://github.com/ursacomputing/crossbow/releases/tag/release-13.0.0-rc3-0-github-test-ubuntu-default-docs doesn't have JS docs.
https://github.com/ursacomputing/crossbow/releases/tag/nightly-tests-2023-09-25-0-github-test-ubuntu-22.04-docs doesn't have JS docs too.

The following log will be related:

https://github.com/ursacomputing/crossbow/actions/runs/6293332503/job/17083717573#step:7:12052

+ '[' ON == ON ']'
++ git config --get remote.origin.url
+ '[' https://github.com/apache/arrow == https://github.com/apache/arrow.git ']'
++ git config --get remote.upstream.url
+ '[' '' == https://github.com/apache/arrow.git ']'
++ git config --get remote.apache.url
+ '[' '' == git@github.com:apache/arrow.git ']'
+ echo 'Failed to build docs because the remote is not set correctly. Please set the origin or upstream remote to https://github.com/apache/arrow.git or the apache remote to git@github.com:apache/arrow.git.'
+ exit 0
Failed to build docs because the remote is not set correctly. Please set the origin or upstream remote to https://github.com/apache/arrow.git or the apache remote to git@github.com:apache/arrow.git.

raulcd added a commit to raulcd/arrow that referenced this issue Sep 26, 2023
@raulcd
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs
1b7b52a
@github-actions github-actions bot mentioned this issue Sep 26, 2023
Merged
@raulcd
Copy link
Member

raulcd commented Sep 26, 2023

I am trying to fix it on main if the issue is solved I'll try and generate the docs from the 13.0.0 branch and create a PR to the docs repo with the JS docs.

kou pushed a commit that referenced this issue Sep 26, 2023
@raulcd
GH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (#37870
517d849 
)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: #37858

Authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
@kou kou added this to the 14.0.0 milestone Sep 26, 2023
@domoritz
Copy link
Member Author

They are back at https://arrow.apache.org/docs/js/ thanks to @raulcd

etseidl pushed a commit to etseidl/arrow that referenced this issue Sep 28, 2023
@raulcd @etseidl
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
ed54324 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
JerAguilon pushed a commit to JerAguilon/arrow that referenced this issue Oct 23, 2023
@raulcd
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
bc13e0d 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this issue Nov 13, 2023
@raulcd @loicalleyne
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
e88aca5 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
dgreiss pushed a commit to dgreiss/arrow that referenced this issue Feb 19, 2024
@raulcd @dgreiss
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
336ea3f 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@raulcd raulcd

Labels
Component: Documentation Component: Website Priority: Critical Type: bug
Projects
None yet
Milestone
14.0.0
Development

Successfully merging a pull request may close this issue.

GH-37858: [Docs][JS] Fix check of remote URL to generate JS docs raulcd/arrow
3 participants
@kou @domoritz @raulcd