docs: remove --recursive on git clone in quick start docs #1539
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our first quick-start command
doesn't work out of the box for many (most?) people, because
--recursive
checks outthirdparty/OpenDataDetector
, which requiresgit-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 explainsgit submodule
, so there is no assumption that the user has already usedgit clone --recursive
. Maybe this could also add a link togit 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.