Code Monkey home page Code Monkey logo

powershell-docs's Introduction

ms.date
02/13/2024

PowerShell Documentation

Welcome to the PowerShell-Docs repository, the home of the official PowerShell documentation.

Microsoft Open Source Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Build Status

live branch main branch
live-badge main-badge

PowerShell Updatable Help (CabGen) CI Build Status

Build Status

Repository Structure

The following list describes the main folders in this repository.

  • .github - contains configuration settings used by GitHub for this repository
  • .vscode - contains configuration settings and recommended extensions for Visual Studio Code (VS Code)
  • assets - contains downloadable files linked in the documentation
  • reference - contains the documentation published to learn.microsoft.com. This includes both reference and conceptual content.
    • 5.1 - contains the cmdlet reference and about topics for PowerShell 5.1
    • 7.2 - contains the cmdlet reference and about topics for PowerShell 7.2
    • 7.3 - contains the cmdlet reference and about topics for PowerShell 7.3
    • 7.4 - contains the cmdlet reference and about topics for PowerShell 7.4
    • 7.5 - contains the cmdlet reference and about topics for PowerShell 7.5
    • bread - contains the TOC used for breadcrumb navigation
    • docs-conceptual - contains the conceptual articles that are published to the Docs site. In general, the folder structure mirrors the Table of Contents (TOC).
    • includes - contains markdown include files
    • mapping - contains the version mapping configuration used by the build system
    • media - contains image files used in documentation. There are media folders throughout the docs-conceptual content. See the Contributor Guide for information on using images in documentation.
    • module - contains the markdown source for the Module Browser page
  • tests - contains the Pester tests used by the build system
  • tools - contains other tools used by the build system

NOTE: The reference content (in the numbered folders) is used to create the webpages on the Docs site as well as the updateable help used by PowerShell. The articles in the docs-conceptual folder are only published to the Docs website.

Contributing

We welcome public contributions into this repository via pull requests into the main branch. Please note that before we can accept your pull request you must sign our Contribution License Agreement. This is a one-time requirement.

For more information on contributing, read our contributor's guide. The contributor's guide contains detailed information about how to contribute documentation, suggested tools, and style and formatting requirements. Please use the Issue and Pull Request templates to help keep documentation consistent across versions.

Licenses

There are two license files for this project. The MIT License applies to the code contained in this repo. The Creative Commons license applies to the documentation.

powershell-docs's People

Contributors

sdwheeler avatar juanpablojofre avatar jpjsm avatar matt9ucci avatar chasewilson avatar huypub avatar hemantmahawar avatar nschonni avatar kiazhi avatar michaeltlombardi avatar davidsmatlak avatar bobbytreed avatar dcthegeek avatar alexandair avatar neemas avatar doctordns avatar joeyaiello avatar sethvs avatar zjalexander avatar mgreenegit avatar stevel-msft avatar mikefrobbins avatar arestarh avatar markekraus avatar v-alje avatar exchange12rocks avatar sankethka avatar travisez13 avatar adityapatwardhan avatar ehmiiz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.