[AG-1455] Documentation Refresh #156
Open
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
jaclynbeck-sage
requested changes
Nov 5, 2024
|
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.
This PR updates
README.md,CONTRIBUTING.md(copied from #153), andprocess.pyto clarify a number of points around how users should run the ADT pipeline. Of note, the topic of how to run the pipeline without GX validation has come up recently and the way to do this as the code is currently written is documented in this PR. That being said, I suggest that a future change should be made to more easily enable this (ticket). I also took the opportunity to do a general refresh of the documentation, and to test the pipeline under a number of different conditions to ensure that the documentation is as up-to-date as possible.