docs: update README for documentation freshness #639
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
- Fix discussion link typo (microsoft#293 -> microsoft#292) - Update 'Switches not available' section to reflect current state - Most switches now implemented (-e, -f, -g, -k, -t, -z, -Z, -r, -X) - Only -j and -p[1] remain unimplemented - Add missing authentication methods to :Connect documentation - ActiveDirectoryInteractive, ActiveDirectoryAzCli, ActiveDirectoryDeviceCode - Fix ActiveDirectoryIntegrated description (no longer falls back) - Document additional authentication methods: - ActiveDirectoryWorkloadIdentity - ActiveDirectoryClientAssertion - ActiveDirectoryAzurePipelines - ActiveDirectoryEnvironment - ActiveDirectoryAzureDeveloperCli - ActiveDirectoryServicePrincipalAccessToken - SqlPassword
dlevy-msft-sql
added
documentation
There was a problem hiding this comment.
Pull request overview
This PR updates the README.md to improve documentation freshness and accuracy by correcting outdated information and adding missing details.
Changes:
- Fixed discussion link typo from #293 to #292
- Updated "Switches not available" section to reflect current implementation (most switches now implemented, only -j and -p[1] remain)
- Corrected ActiveDirectoryIntegrated authentication description (removed outdated fallback text)
- Added missing authentication methods to documentation (ActiveDirectoryInteractive, ActiveDirectoryAzCli, ActiveDirectoryDeviceCode, and additional methods via --authentication-method)
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.
Summary
Updates the README.md to fix documentation freshness issues and improve accuracy.
Changes
Fixed Issues
Discussion link typo: Fixed link text from Require --password-encryption for add-user #293 to Prioritize implementation of back-compat flags #292 (the link URL was correct but display text was wrong)
Updated 'Switches not available' section: Reflects current implementation state
Fixed ActiveDirectoryIntegrated description: Removed outdated text saying it falls back to ActiveDirectoryDefault (it's now fully implemented)
Added missing authentication methods to :Connect documentation:
Documented additional authentication methods that are available via --authentication-method:
Related
This addresses documentation freshness issues identified when comparing the README with the actual implementation in \cmd/sqlcmd/sqlcmd.go\ and the Microsoft Learn documentation.
Testing
Documentation-only change - no functional changes.