docs(sqldef): replace template README with real documentation - #54
Open
vanshika2720 wants to merge 1 commit into
Open
docs(sqldef): replace template README with real documentation#54vanshika2720 wants to merge 1 commit into
vanshika2720 wants to merge 1 commit into
Conversation
Document the sqldef plugin's actual implementation: supported database type, stages, config schema, tool download/auth behavior, and known limitations, in place of the unfilled README template. Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
Author
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.
What this PR does
Replaces the placeholder
sqldefplugin README with complete documentation based on the current implementation.The documentation covers the supported database type, deployment stages, configuration schema, tool download and authentication behavior, usage examples, troubleshooting, development/testing, and known limitations.
No production code is changed.
Why we need it / Without this PR, what is the problem?
The
sqldefplugin README was still using the generated template, leaving important implementation details and usage constraints undocumented.This PR provides accurate documentation for users and contributors, including limitations such as MySQL-only support, schema file handling, tool configuration, and current stage behavior.