Skip to content

docs: refresh install, auth, troubleshooting for v0.62.0#451

Merged
jagger merged 2 commits into
devfrom
jagger/docs-refresh-v0.62.0
May 21, 2026
Merged

docs: refresh install, auth, troubleshooting for v0.62.0#451
jagger merged 2 commits into
devfrom
jagger/docs-refresh-v0.62.0

Conversation

@jagger

@jagger jagger commented May 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Phase 1 + 2 of the v0.62.0 documentation refresh (see plan in tracking conversation).

Phase 1 — install & prerequisites:

  • PSGallery flagged as not updated past 0.60.4 with link to tracking issue PowerShell Gallery release not updated past 0.60.4 #450 from README, install.md, and the docs landing page
  • Fix garbled "Windows Powershell PowerShell 7+" prerequisite. PS 7+ is now stated as required for new installs; Windows PowerShell 5.1 remains supported for older module releases (cross-linked to the new Troubleshooting page)
  • Add SHA256 integrity verification snippet and an installed-version confirmation snippet
  • Add a CHANGELOG release-notes link to the docs landing page

Phase 2 — authentication & TLS:

  • Document the new + "-SkipCertificateCheck" + switch on + "New-TssSession" + (v0.62.0 RestSharp 112 stopped trusting self-signed certs by default)
  • Rename the + "Login-SS" + PowerShell-profile sample to + "Connect-SS" + (approved verb) and add the missing + "-IgnoreDefault" + switch parameter so the existing + "if (-not $ignoreDefault)" + branch actually does something
  • Fix duplicate-verb typo ("creates creating that")
  • New + "docs/getting_started/troubleshooting.md" + covering TLS 1.2 on PS 5.1, + "TaskCanceledException" + from self-signed certs, cast errors, and how to capture a verbose session for bug reports

Out of scope (separate PRs):

  • Phase 3: + "New-TssSession.md" + platyPS regeneration for the + "OtpCode" + int→string fix
  • Phase 4: Compatibility matrix update and + "event-pipeline" + folder rename

Refs #450

Test plan

  • Render the Jekyll site locally (or via GitHub Pages preview) and confirm:
  • Validate PowerShell snippets in a PS 7 session:
    • + "Get-FileHash -Algorithm SHA256" + against the published zip
    • + "New-TssSession -SkipCertificateCheck" + against a self-signed lab Secret Server
    • + "Connect-SS" + profile sample loads cleanly when sourced into + "$PROFILE" +
  • No broken inbound links from other docs pages (no references to the removed "Direct File Download" anchor)

Generated with Claude Code

jagger and others added 2 commits May 21, 2026 02:13
Phase 1: install & prerequisites
- Mark PSGallery as not-updated past 0.60.4 (tracking #450), link issue
  from README, install.md, and docs landing page
- Fix garbled "Windows Powershell PowerShell 7+" prereq; PS 7+ required
  for new installs, PS 5.1 still supported for older releases
- Add SHA256 integrity verification snippet and version-check snippet
- Add CHANGELOG release-notes link to docs landing page

Phase 2: authentication & TLS
- Document new -SkipCertificateCheck switch on New-TssSession (v0.62.0
  RestSharp 112 stopped trusting self-signed certs by default)
- Rename Login-SS profile sample to Connect-SS, add -IgnoreDefault param
  so the existing branch actually does something; fix duplicate-verb typo
- New troubleshooting.md covering TLS 1.2 on PS 5.1, TaskCanceledException
  on self-signed certs, cast errors, and how to capture verbose logs

Refs #450

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…ificateCheck)

- OtpCode parameter type changed Int32 -> String in v0.62.0 to preserve
  leading zeros (e.g. '012345'). Update SYNTAX and parameter table.
- Document the new -SkipCertificateCheck switch (available in all
  parameter sets) added in v0.62.0 alongside the RestSharp 112 upgrade.

Hand-edited rather than regenerated via build.ps1 because the docs
build task strips Jekyll frontmatter from every cmdlet page (see #452).

Refs #452

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@jagger jagger force-pushed the jagger/docs-refresh-v0.62.0 branch from 391dea3 to af43019 Compare May 21, 2026 06:13
@jagger jagger merged commit e92b393 into dev May 21, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant