Added 'Submodule Compatibility Guide' link to dockerhub documentation #69
+3
−0
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.
PR Details
Description
Problem
The dockerhub documentation for the project references submodules, but does not provide guidance on what versions of the submodules to use.
Solution
A link to the 'Submodule Compatibility Guide' has been added to the dockerhub documentation. This is currently linking to the CDOT fork, as the guide does not yet exist in the parent project. A local reference would have been used, but the dockerhub documentation is expected to be posted on the DockerHub page for the ODE image, so a direct link is more suited here.
Related Issue
No related GitHub issue.
Motivation and Context
Users who are reading the dockerhub documentation should be aware of the Submodule Compatibility Guide.
How Has This Been Tested?
Clicking on the link has been verified to properly redirect to the blob page on the dev branch of CDOT's fork.
Types of changes
Checklist:
ODE Contributing Guide