GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Move conceptual documentation to the docs repo · Issue #1723 · PowerShell/PSScriptAnalyzer

Move conceptual documentation to the docs repo #1723

New issue
Copy link
New issue
Copy link
Closed
#1790
Closed
Move conceptual documentation to the docs repo#1723
#1790
Copy link
Assignees
sdwheeler
Labels
Area - Documentation

Description

@sdwheeler
Sean Wheeler (sdwheeler)
opened on Oct 4, 2021
Issue body actions

This is one of several issues for managing the documentation in preparation for publishing on docs.microsoft.com.

Move the following articles to the docs repo

  • https://github.com/PowerShell/PSScriptAnalyzer/blob/master/PowerShellBestPractices.md
  • https://github.com/PowerShell/PSScriptAnalyzer/blob/master/ScriptRuleDocumentation.md

Update the README.md

  • Most of the content of the README should be in a usage document in the docs repo.
  • Content specific to using or building the source code and the rules of the repo belong in the README.
  • Update the README to point to the new documentation online.

Activity

  1. Sean Wheeler (sdwheeler)
    added
    Area - Documentation
    on Oct 4, 2021
  2. Sean Wheeler (sdwheeler)
    self-assigned this
    on Oct 4, 2021
  3. James Truher (JamesWTruher)
    closed this as completedin #1790on May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

  • @sdwheeler
    Sean Wheeler (sdwheeler)

Labels

Area - Documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    You are visitor 01402520 — GeezerVison does not store the pages you look up.
    Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.