Add submodule initialization commands to docs #5459
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@twosdai thanks for contributing to the docs. I don't have merge power but looks good to me 👍 |
|
Let me know if there is anything else I need to do in order to help this merge along, just don't want it to sit around for ever and die of atrophy. |
|
@cdrini Just looping back to this as I saw it in my open pull requests, if there is someone else I should bother about it LMK. |
cdrini
force-pushed
the
DockerReadmeUpdate
branch
from
95a59d7 to
1632e62
Compare
cdrini
approved these changes
May 27, 2022
cdrini
changed the title
cclauss
pushed a commit
to cclauss/openlibrary
that referenced
this pull request
May 31, 2022
Co-authored-by: Daniel Wasserlauf <Daniel.Wasserlauf@marklogic.com> Co-authored-by: Drini Cami <cdrini@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No issues exists around this issue as far as I can tell, it may relate to the work done in #5455 so reasonably it could be added to that PR.
This is a slight addition to the documentation when downloading and initializing git submodules if they are not setup when first pulled there are some commands which can be ran to help the user install them.
specifically
git submodule init && git submodule updateTechnical
No technical changes, just some documentation updates for getting started.
Testing
Clone the repository using HTTP, run
git submodule initand thengit submodule updatefrom the root of the repositoryThe following should appear:
Screenshot
No UI changes for this PR
Stakeholders
@RayBB I see that you have another Docs related ticket, I am not sure who the correct stakeholders are for this as it is my first PR.
@jamesachamp