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 #64

Merged
merged 2 commits into from
Mar 25, 2024

Conversation

dmccoystephenson
Copy link
Member

@dmccoystephenson dmccoystephenson commented Mar 15, 2024

PR Details

Description

The documentation now provides a useful table to guide users in selecting compatible versions of submodules for their chosen version of the project.

Related Issue

No related issue.

Motivation and Context

Previously, users lacked guidance on which submodule versions were suitable for a specific version of the project. They had to resort to methods like checking release dates, inspecting git submodule commits, or relying on the 'latest' tag on DockerHub, which was often uncertain. This update aims to simplify the deployment process.

How Has This Been Tested?

Since this update involves documentation only, no testing is required.

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

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 8d7f869 into dev Mar 25, 2024
3 of 4 checks passed
@payneBrandon payneBrandon deleted the docs/version-compatibility-matrix branch March 25, 2024 18:57
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