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

docs: remove --recursive on git clone in quick start docs #1539

Merged
merged 2 commits into from
Sep 22, 2022

Conversation

timadye
Copy link
Contributor

@timadye timadye commented Sep 20, 2022

Our first quick-start command

git clone --recursive https://github.com/acts-project/acts

doesn't work out of the box for many (most?) people, because --recursive checks out thirdparty/OpenDataDetector, which requires git-lfs, which isn't usually installed by default. It's on lxplus, but I didn't find it anywhere else by default.

I propose to remove the --recursive option in the quick-start docs. The ODD quick-start already explains git submodule, so there is no assumption that the user has already used git clone --recursive. Maybe this could also add a link to git lfs (I'll see about a small update).

An alternative would be to add git-lfs to the list of dependencies, but this could be misleading as it isn't a compile-time dependency.

@codecov
Copy link

codecov bot commented Sep 20, 2022

Codecov Report

Merging #1539 (45b922b) into main (b99368a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1539   +/-   ##
=======================================
  Coverage   48.47%   48.47%           
=======================================
  Files         381      381           
  Lines       20699    20699           
  Branches     9503     9503           
=======================================
  Hits        10034    10034           
  Misses       4112     4112           
  Partials     6553     6553           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@timadye timadye added this to the next milestone Sep 20, 2022
@kodiakhq kodiakhq bot merged commit bfc3676 into acts-project:main Sep 22, 2022
@paulgessinger paulgessinger modified the milestones: next, v20.2.0 Sep 23, 2022
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.

None yet

3 participants