Skip to content

docs(FailoverClusters): Use primary parameter name -ForceQuorum in Start-ClusterNode examples#4100

Merged
robinharwood merged 3 commits intomainfrom
copilot/update-start-cluster-node-example
Apr 22, 2026
Merged

docs(FailoverClusters): Use primary parameter name -ForceQuorum in Start-ClusterNode examples#4100
robinharwood merged 3 commits intomainfrom
copilot/update-start-cluster-node-example

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 21, 2026

PR Summary

Start-ClusterNode.md (WS2025) referenced the alias -FixQuorum in user-facing prose and Example 3 instead of the primary parameter name -ForceQuorum, conflicting with the SYNTAX block and PARAMETERS definition.

Changes

  • DESCRIPTION section: **FixQuorum****ForceQuorum**
  • Example 3: Start-ClusterNode -FixQuorumStart-ClusterNode -ForceQuorum
# Before
Start-ClusterNode -FixQuorum

# After
Start-ClusterNode -ForceQuorum

The Aliases: fq, FixQuorum entry on the -ForceQuorum parameter block is intentionally left unchanged — FixQuorum remains a valid alias; this only corrects user-facing references to use the canonical name.

Original prompt

Summary

The Start-ClusterNode cmdlet reference page for Windows Server 2025 contains an inaccurate parameter name in Example 3 and in the DESCRIPTION section. Both places use FixQuorum rather than the correct primary parameter name ForceQuorum. While FixQuorum is listed as an alias (along with fq) on the -ForceQuorum parameter, the SYNTAX block and ## PARAMETERS section document the primary name as -ForceQuorum. Customers following Example 3 can be confused because the example does not match the syntax definition.

File to update:

Required changes

  1. Example 3 (around line 65): Replace the code sample so it uses the primary parameter name.

    Change:

    Start-ClusterNode -FixQuorum

    to:

    Start-ClusterNode -ForceQuorum
  2. DESCRIPTION section (around line 30): Update the prose that references the parameter by name.

    Change:

    This cmdlet with the FixQuorum parameter can be used to force quorum...

    to:

    This cmdlet with the ForceQuorum parameter can be used to force quorum...

Consistency checks to perform

  • Verify every parameter referenced in EXAMPLES and DESCRIPTION matches a primary parameter name listed in the SYNTAX block and the ## PARAMETERS section.
  • Confirm the SYNTAX block (Start-ClusterNode [[-Name] <StringCollection>] [-ForceQuorum] [-ClearQuarantine] [-IgnorePersistentState] [-PreventQuorum] [-Wait <Int32>] [-InputObject <PSObject>] [-Cluster <String>] [<CommonParameters>]) remains unchanged.
  • Leave the -ForceQuorum parameter's Aliases: fq, FixQuorum line intact — FixQuorum remains a valid alias; this change only updates user-facing examples and prose to use the primary parameter name.
  • Do not modify any other cmdlet pages under docset/winserver2025-ps/FailoverClusters/ as part of this PR.
  • Do not change ms.date metadata unless the repo's contribution guide (see CONTRIBUTING.md at the repo root) requires it; if it does, update to today's date.

Out of scope

  • Changes to other FailoverClusters cmdlet pages.
  • Localization or non-English content.
  • Any workflow/permissions changes.

Acceptance criteria

  • Start-ClusterNode.md Example 3 uses -ForceQuorum.
  • The DESCRIPTION paragraph references ForceQuorum instead of FixQuorum.
  • SYNTAX and PARAMETERS sections are unchanged (including the FixQuorum alias on -ForceQuorum).
  • markdownlint / build checks pass and no other files are modified.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: Customer Intent
As a Windows Server administrator, I want to use accurate PowerShell examples for Start-ClusterNode, so that I can configure and recover clusters without confusion or errors.

Problem
The Start-ClusterNode cmdlet page contains an incorrect parameter name in Example 3: it references FixQuorum instead of the correct ForceQuorum. This discrepancy conflicts with the API/parameter definition and confuses customers trying to follow the example. A contributor also reported being unable to submit a fix due to repository fork/edit permission issues.

Why Now
Customer-reported error is causing confusion and potential misconfiguration. Addressing this promptly improves technical accuracy and reduces support friction for Windows Server 2025 Failover Clusters content.

Desired Outcome
The cmdlet documentation accurately reflects supported parameters and examples align with the API definition. Customers can reliably execute Example 3 using ForceQuorum without ambiguity. Contribution pathway is confirmed so future fixes can be submitted efficiently.

In Scope
Correct Example 3 on Start-ClusterNode.md by replacing FixQuorum with ForceQuorum and validating syntax.
Verify all parameter references on the page align with the API/parameter set definition.
Run a consistency check across examples for Start-ClusterNode to ensure naming and switches are accurate.
Confirm contributor edit/fork workflow for this repo and reference the contributor guide.
Out of Scope
Broader updates to other FailoverClusters cmdlet pages.
Localization or non-English content changes.
Workflow/process changes to GitHub org permissions beyond documenting the standard contribution path.

Assistant: Waiting for your response to the confirmation dialog before I can continue and dispatch the coding agent to open the PR.

This pull request was created from Copilot chat.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

…tart-ClusterNode.md

Agent-Logs-Url: https://github.com/MicrosoftDocs/windows-powershell-docs/sessions/3ae8f137-c86c-4321-b6f6-4b5a7f227e94

Co-authored-by: robinharwood <19212983+robinharwood@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix parameter name in Start-ClusterNode cmdlet documentation docs(FailoverClusters): Use primary parameter name -ForceQuorum in Start-ClusterNode examples Apr 21, 2026
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Copilot AI requested a review from robinharwood April 21, 2026 13:19
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 26865e4:

✅ Validation status: passed

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit ce90351:

💡 Validation status: suggestions

File Status Preview URL Details
docset/winserver2025-ps/FailoverClusters/Start-ClusterNode.md 💡Suggestion View (WindowsServer2025-ps) Details

docset/winserver2025-ps/FailoverClusters/Start-ClusterNode.md

  • Line 0, Column 0: [Suggestion: PSMD2Yaml_ContentMissing] Missing content in FailoverClusters.Start-ClusterNode cmdlet. Parameters lacking description: ClearQuarantine

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@robinharwood robinharwood marked this pull request as ready for review April 21, 2026 14:43
@sc-dstrome sc-dstrome closed this Apr 21, 2026
@sc-dstrome sc-dstrome reopened this Apr 21, 2026
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit ce90351:

💡 Validation status: suggestions

File Status Preview URL Details
docset/winserver2025-ps/FailoverClusters/Start-ClusterNode.md 💡Suggestion View (WindowsServer2025-ps) Details

docset/winserver2025-ps/FailoverClusters/Start-ClusterNode.md

  • Line 0, Column 0: [Suggestion: PSMD2Yaml_ContentMissing] Missing content in FailoverClusters.Start-ClusterNode cmdlet. Parameters lacking description: ClearQuarantine

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit dba5db7:

💡 Validation status: suggestions

File Status Preview URL Details
docset/winserver2025-ps/FailoverClusters/Start-ClusterNode.md 💡Suggestion View (WindowsServer2025-ps) Details

docset/winserver2025-ps/FailoverClusters/Start-ClusterNode.md

  • Line 0, Column 0: [Suggestion: PSMD2Yaml_ContentMissing] Missing content in FailoverClusters.Start-ClusterNode cmdlet. Parameters lacking description: ClearQuarantine

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@robinharwood robinharwood merged commit 8d3ac55 into main Apr 22, 2026
10 checks passed
@robinharwood robinharwood deleted the copilot/update-start-cluster-node-example branch April 22, 2026 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants