61 add sdx release as submodule for canonical release notes#62
Open
61 add sdx release as submodule for canonical release notes#62
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
An automated document-syncing workflow has been created for the AtlanticWave-SDX project to increase the sustainability and ease of use of the project's ecosystem. Using Git submodules to link the official software release repo (sdx-release) to the centralized documentation (sdx-docs) will gives domain scientists and network operators instant access to the canonical, versioned release notes. This architectural improvement eliminates manual duplication errors from the documentation process, maintains long-term consistency in the recording of software milestone events, and creates a transparent audit trail of how the platform has grown over time consistent with NSF goals for research software that is reproducible and well maintained.