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-17512: [Doc] Updates to crossbow documentation for clarity #13993

Merged
merged 23 commits into from
Sep 29, 2022

Conversation

lafiona
Copy link
Contributor

@lafiona lafiona commented Aug 29, 2022

Overview

While setting up a queue repository for testing changes to crossbow, we noticed some updates that can be made to help future developers set up their environment.

Implementation

  1. Clarify Travis CI auto-cancellation default behavior.
  2. Fix broken links referenced by instructions.
  3. Minor typos.

Testing

  1. Qualified by performing a directory level sphinx build and visually verifying the changes.

Notes

Thank you for your help on this pull request, @kevingurney!

@github-actions
Copy link

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on JIRA? https://issues.apache.org/jira/browse/ARROW

Opening JIRAs ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename pull request title in the following format?

ARROW-${JIRA_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

See also:

@lafiona lafiona changed the title [WIP] ARROW-17512: Updates to crossbow documentation for clarity [WIP] ARROW-17512: [Doc] Updates to crossbow documentation for clarity Aug 29, 2022
@lafiona lafiona changed the title [WIP] ARROW-17512: [Doc] Updates to crossbow documentation for clarity ARROW-17512: [Doc] Updates to crossbow documentation for clarity Sep 1, 2022
@lafiona lafiona marked this pull request as ready for review September 1, 2022 20:58
@github-actions
Copy link

github-actions bot commented Sep 1, 2022

@github-actions
Copy link

github-actions bot commented Sep 1, 2022

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

Copy link
Member

@pitrou pitrou left a comment

Choose a reason for hiding this comment

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

LGTM in general. Just a couple comments.

@pitrou
Copy link
Member

pitrou commented Sep 28, 2022

@lafiona @kevingurney Sorry, I noticed some other items that needed updating as well! (see the comments I posted above)

Copy link
Member

@pitrou pitrou left a comment

Choose a reason for hiding this comment

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

+1, this is a nice improvement. Thank you @lafiona @kevingurney

@pitrou
Copy link
Member

pitrou commented Sep 28, 2022

Will wait for CI before merging.

@pitrou pitrou merged commit 60c9383 into apache:master Sep 29, 2022
@ursabot
Copy link

ursabot commented Sep 29, 2022

Benchmark runs are scheduled for baseline = ec714db and contender = 60c9383. 60c9383 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
[Failed ⬇️0.78% ⬆️0.0%] test-mac-arm
[Failed ⬇️0.0% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.36% ⬆️0.04%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] 60c93833 ec2-t3-xlarge-us-east-2
[Failed] 60c93833 test-mac-arm
[Failed] 60c93833 ursa-i9-9960x
[Finished] 60c93833 ursa-thinkcentre-m75q
[Finished] ec714db3 ec2-t3-xlarge-us-east-2
[Finished] ec714db3 test-mac-arm
[Failed] ec714db3 ursa-i9-9960x
[Finished] ec714db3 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

fatemehp pushed a commit to fatemehp/arrow that referenced this pull request Oct 17, 2022
…che#13993)

## Overview
While setting up a queue repository for testing changes to `crossbow`, we noticed some updates that can be made to help future developers set up their environment. 

## Implementation
1. Clarify Travis CI auto-cancellation default behavior.
2. Fix broken links referenced by instructions.
3. Minor typos.

## Testing
1. Qualified by performing a directory level sphinx build and visually verifying the changes.

## Notes
Thank you for your help on this pull request, @kevingurney!

Lead-authored-by: Fiona La <fionala7@gmail.com>
Co-authored-by: Kevin Gurney <kgurney@mathworks.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
@kevingurney kevingurney deleted the ARROW-17512 branch August 21, 2023 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants