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

Added 'Submodule Compatibility Guide' link to dockerhub documentation #69

Merged
merged 1 commit into from
Apr 16, 2024

Conversation

dmccoystephenson
Copy link
Member

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

  • Defect fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that cause existing functionality to change)
  • Documentation update

Checklist:

  • I have added any new packages to the sonar-scanner.properties file
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
    ODE Contributing Guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link

@mwodahl mwodahl left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link

@payneBrandon payneBrandon left a comment

Choose a reason for hiding this comment

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

lgtm!

@payneBrandon payneBrandon merged commit 4359951 into dev Apr 16, 2024
3 of 4 checks passed
@payneBrandon payneBrandon deleted the docs/add-scg-link-to-dockerhub-docs branch April 16, 2024 15:14
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.

3 participants