chore: release 3.1.0

[lowlydba]

Description

Standardizes the names and formatting used across module documentation examples, and corrects examples that referenced unsupported parameters, omitted required options, or called the wrong module. Credential examples now use Ansible Vault variables instead of literal password placeholders.

Bumps galaxy.yml to 3.1.0 and runs antsibull-changelog release to consume the pending fragments (381, 382, 399) into changelogs/changelog.yaml and CHANGELOG.rst.

How Has This Been Tested?

Parsed every module example as YAML, checked that referenced modules and required options resolve, and ran antsibull-changelog lint (via WSL, since ansible-doc requires POSIX blocking-IO support Windows doesn't provide) both before and after the release.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Checklist:

• I have read/followed the CONTRIBUTING document.
• I have read/followed the PR Quick Start Guide
• I have added tests to cover my changes or they are N/A.
• I have added a changelog fragment describing the changes.
• New module options/parameters include a version_added property.

[github-actions]

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and the docs are now incorporated into main:
https://lowlydba.github.io/lowlydba.sqlserver/branch/main

[Copilot]

🟡 Changes recommended

Several examples remain invalid or misleading, including malformed YAML, incorrect schedule formats, and an invalid listener subnet.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Standardizes SQL Server module examples for consistency and correctness.

Changes:

• Normalizes example names, hosts, databases, and identifiers.
• Corrects module references and adds required parameters.
• Replaces literal credentials with Ansible Vault variables.

File summaries

File	Description
plugins/modules/user.py	Corrects user module examples.
plugins/modules/user_role.py	Standardizes database-role examples.
plugins/modules/traceflag.py	Clarifies trace-flag examples.
plugins/modules/tcp_port.py	Standardizes port examples.
plugins/modules/spn.py	Simplifies SPN examples.
plugins/modules/sp_whoisactive.py	Standardizes installation example.
plugins/modules/sp_configure.py	Clarifies configuration example.
plugins/modules/sa.py	Standardizes sa-login examples.
plugins/modules/rg_workload_group.py	Updates Resource Governor workflow.
plugins/modules/rg_resource_pool.py	Updates resource-pool examples.
plugins/modules/restore.py	Adds required backup paths.
plugins/modules/resource_governor.py	Standardizes enablement example.
plugins/modules/nonquery.py	Updates DML example.
plugins/modules/memory.py	Clarifies memory examples.
plugins/modules/maintenance_solution.py	Corrects module and options.
plugins/modules/login.py	Uses a Vault password variable.
plugins/modules/login_role.py	Corrects login terminology.
plugins/modules/instance_info.py	Standardizes instance example.
plugins/modules/install_script.py	Clarifies migration example.
plugins/modules/hadr.py	Clarifies HADR restart behavior.
plugins/modules/first_responder_kit.py	Standardizes installation example.
plugins/modules/dba_multitool.py	Standardizes installation values.
plugins/modules/database.py	Standardizes database examples.
plugins/modules/credential.py	Adds names and Vault credentials.
plugins/modules/backup.py	Standardizes backup examples.
plugins/modules/availability_group.py	Standardizes availability-group example.
plugins/modules/agent_job.py	Standardizes Agent job example.
plugins/modules/agent_job_step.py	Updates job-step examples.
plugins/modules/agent_job_schedule.py	Adds required job and schedule values.
plugins/modules/agent_job_category.py	Standardizes category example.
plugins/modules/ag_replica.py	Standardizes replica workflow.
plugins/modules/ag_listener.py	Updates listener workflow.
changelogs/fragments/399-documentation-examples.yml	Records documentation updates.

Review details

• Files reviewed: 33/33 changed files
• Comments generated: 5
• Review effort level: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.