diff --git a/reference/docfx.json b/reference/docfx.json index 8488878a967..5fe7f7016a7 100644 --- a/reference/docfx.json +++ b/reference/docfx.json @@ -138,6 +138,7 @@ "ms.devlang": "powershell", "ms.service": "powershell", "ms.tgt_pltfr": "windows, macos, linux", + "ms.update-cycle": "365-days", "searchScope": [ "PowerShell" ], diff --git a/reference/docs-conceptual/dsc/overview.md b/reference/docs-conceptual/dsc/overview.md index f80d747cee8..d5f4885ebfe 100644 --- a/reference/docs-conceptual/dsc/overview.md +++ b/reference/docs-conceptual/dsc/overview.md @@ -1,6 +1,7 @@ --- description: DSC is a management platform that enables you to manage your IT and development infrastructure with configuration as code. ms.date: 03/18/2025 +ms.update-cycle: 3650-days title: Desired State Configuration (DSC) --- diff --git a/reference/docs-conceptual/how-to-use-docs.md b/reference/docs-conceptual/how-to-use-docs.md index 1562a99d772..c020aeb3f90 100644 --- a/reference/docs-conceptual/how-to-use-docs.md +++ b/reference/docs-conceptual/how-to-use-docs.md @@ -1,45 +1,96 @@ --- -description: This articles explains how to use the features of this site including search filtering and version selection. -ms.date: 01/17/2025 +description: This article explains how to use the features of this site including search filtering and version selection. +ms.date: 01/28/2026 ms.topic: how-to title: How to use the PowerShell documentation --- # How to use the PowerShell documentation -Welcome to the PowerShell online documentation. This site contains cmdlet reference for the -following versions of PowerShell: +Welcome to the PowerShell online documentation. -- PowerShell 7.6 (preview) -- PowerShell 7.5 (RC) -- PowerShell 7.4 (LTS) -- PowerShell 5.1 +## Features of the Learn platform -## Navigating the documentation +The web page contains multiple elements that help you use and navigate the documentation. ![Screenshot showing the various elements of the web page.][02] -The web page contains multiple elements that help you navigate the documentation. +### Navigation elements - **Site level navigation** - The site level navigation appears at the top of the page. It contains links to other content on the Microsoft Learn platform. - **Related content navigation** - The related content bar is immediately below the site level navigation. It contains links to content related to the current documentation set, which is PowerShell in this case. +- **Article navigation** - The article navigation appears at the top right of the article. It + contains links to sections within the article. + +### Table of Contents + - **Version selector** - The version selector appears above the Table of Contents (TOC) and - controls which version of the cmdlet reference appears in the TOC. -- **Table of Contents** - The TOC on the left side of the page is divided into two sections: - conceptual and reference. Notice the line between the **Reference** node of the TOC. The - conceptual documents appear above the line. Reference content is listed in **Reference** node - below the line. -- **Action buttons** - The action buttons provide a way to add content to a collection, provide - feedback, edit the content, or share the content with others. + controls which version of the **cmdlet reference** appears in the TOC. +- The **Filter and search** box allows you to quickly find articles in the TOC by filtering on words + that appear in the title of an article. +- **Conceptual content** - The top section of the TOC contains conceptual articles that aren't + version-specific. +- **Cmdlet reference** - The bottom section of the TOC contains the cmdlet reference for the + version of PowerShell selected in the version selector. + +### Action and menu buttons + +These buttons provide other ways of interacting with the content. + +- The **Ask Learn** button opens an AI chat pane where you can ask questions and get help about + the content. +- The **Focus mode** button hides the TOC and other distractions, allowing you to focus on the + content. +- The **Menu** button provides a way to add content to a collection, provide feedback, edit the + content, or share the content with others. + +### Feedback elements + +There are two ways to provide feedback on the documentation. + +- **Anonymous feedback** - The **Was this helpful?** section on the right side of the article allows + you to provide a thumbs-up or thumbs-down rating. You can also enter more feedback in a text box. +- **Feedback on GitHub** - At the bottom of each article, you can provide feedback on the + documentation or the product. These links take you to the GitHub repository where you can open an + issue and give feedback. + +## Filter and search for articles + +There are two ways to search for content in Docs. + +- The filter and search box under the version selector allows filtering articles by words that + appear in the title of an article or command aliases. The filter displays a list of matching + articles as you type. You can also select the option to search for the words in the body of + articles. When you search from here, the search is limited to the PowerShell documentation. +- The search box in the site-level navigation bar searches the entire site. It returns a list of + matching articles from all documentation sets. + +In the following example, you see how the drop-down list is filtered to show the `Get-ChildItem` +command as you type the name. When you enter `gci`, the filter shows the `Get-CimInstance` and +`Get-ChildItem` commands because the alias for both commands starts with `gci`. + +Next, the word `idempotent` is entered. The filter shows no articles. Clicking the search link +searches for `idempotent` in the PowerShell documentation. This search only returns 12 results. +Notice the difference when the same word is searched using the site-level search box. The search +returns 1,096 articles from the entire Microsoft Learn site. + +![Animation showing how to use the search features.][05] ## Selecting the version of PowerShell +This site contains cmdlet reference for the following versions of PowerShell: + +- PowerShell 7.6 (preview) +- PowerShell 7.5 +- PowerShell 7.4 (LTS) +- PowerShell 5.1 + Use the version selector located above the TOC to select the version of PowerShell you want. By default, the page loads with the most current stable release version selected. The version selector controls which version of the cmdlet reference appears in the TOC under the **Reference** node. Some -cmdlets work differently in different versions of PowerShell you are using. Be sure you are viewing +cmdlets work differently in different versions of PowerShell you're using. Be sure you're viewing the documentation for the correct version of PowerShell. The version selector doesn't affect conceptual documentation. The conceptual documents appear above @@ -48,7 +99,7 @@ If there are version-specific differences, the documentation makes note of those ![Animation showing how to use the version selector.][06] -You can verify the version of PowerShell you are using by inspecting the `$PSVersionTable.PSVersion` +You can verify the version of PowerShell you're using by inspecting the `$PSVersionTable.PSVersion` value. The following example shows the output for Windows PowerShell 5.1. ```powershell @@ -58,47 +109,18 @@ $PSVersionTable.PSVersion ```Output Major Minor Build Revision ----- ----- ----- -------- -5 1 22621 963 +5 1 26100 7705 ``` -## Finding articles - -There are two ways to search for content in Docs. - -- The search box in the site-level navigation bar searches the entire site. It returns a list of - matching articles from all documentation sets. -- The TOC filter box under the version selector allows filtering by words that appear in the title - of an article. The filter displays a list of matching articles as you type. You can also select - the option to search for the words in an article. When you search from here, the search is - limited to the PowerShell documentation. - -In the following example, the search in the site-level navigation bar returns 840 results for the -word `idempotent`. Entering the word `invoke` in the TOC filter box shows a list of articles that -contain the word `invoke` in the title. Entering the word `idempotent` in the TOC filter shows no -articles. Clicking the search link searches for `idempotent` in the PowerShell documentation. This -search only returns 9 results. - -![Animation showing how to use the search features.][05] - -## Downloading the documentation as a PDF - -To download the documentation as a PDF, click the **Download PDF** button at the bottom of the TOC. - -![Screenshot of the Download PDF button.][03] - -- If you are viewing a conceptual article, the Learn platform creates a PDF containing all the - conceptual content for the selected version. -- If you are viewing a reference article, the Learn platform creates a PDF containing all the - reference content for the selected version. - -## Finding articles for previous versions +### Find articles for older versions of PowerShell Documentation for older versions of PowerShell is archived in our [Previous Versions][01] site. You can choose **Previous Versions** from the version selector. ![Screenshot of the Previous Versions option.][04] -The previous versions site contains documentation for the following topics: +The **Previous versions** option takes you to the site containing documentation for older and +unsupported versions of PowerShell: - PowerShell 7.3 - PowerShell 7.2 @@ -106,15 +128,28 @@ The previous versions site contains documentation for the following topics: - PowerShell 7.0 - PowerShell 6 - PowerShell 5.0 + - WMF 5.x Release notes + - PowerShell ISE object model - PowerShell Workflows - PowerShell Web Access - PowerShell 4.0 - PowerShell 3.0 +## Download the documentation as a PDF + +To download the documentation as a PDF, select the **Download PDF** button at the bottom of the TOC. + +![Screenshot of the Download PDF button.][03] + +- If you're viewing a conceptual article, the Learn platform creates a PDF containing the conceptual + content for the selected version. +- If you're viewing a reference article, the Learn platform creates a PDF containing the reference + content for the selected version. + [01]: https://aka.ms/PSLegacyDocs [02]: media/how-to-use-docs/how-to-use.gif -[03]: media/how-to-use-docs/pdf-button.gif -[04]: media/how-to-use-docs/previous-versions.gif +[03]: media/how-to-use-docs/pdf-button.png +[04]: media/how-to-use-docs/previous-versions.png [05]: media/how-to-use-docs/search-scope.gif [06]: media/how-to-use-docs/version-search.gif diff --git a/reference/docs-conceptual/media/how-to-use-docs/how-to-use.gif b/reference/docs-conceptual/media/how-to-use-docs/how-to-use.gif index c74e9590b54..09faa087b62 100644 Binary files a/reference/docs-conceptual/media/how-to-use-docs/how-to-use.gif and b/reference/docs-conceptual/media/how-to-use-docs/how-to-use.gif differ diff --git a/reference/docs-conceptual/media/how-to-use-docs/pdf-button.gif b/reference/docs-conceptual/media/how-to-use-docs/pdf-button.gif deleted file mode 100644 index 7cad72266ba..00000000000 Binary files a/reference/docs-conceptual/media/how-to-use-docs/pdf-button.gif and /dev/null differ diff --git a/reference/docs-conceptual/media/how-to-use-docs/pdf-button.png b/reference/docs-conceptual/media/how-to-use-docs/pdf-button.png new file mode 100644 index 00000000000..c5622de26ba Binary files /dev/null and b/reference/docs-conceptual/media/how-to-use-docs/pdf-button.png differ diff --git a/reference/docs-conceptual/media/how-to-use-docs/previous-versions.gif b/reference/docs-conceptual/media/how-to-use-docs/previous-versions.gif deleted file mode 100644 index ccb60e115f3..00000000000 Binary files a/reference/docs-conceptual/media/how-to-use-docs/previous-versions.gif and /dev/null differ diff --git a/reference/docs-conceptual/media/how-to-use-docs/previous-versions.png b/reference/docs-conceptual/media/how-to-use-docs/previous-versions.png new file mode 100644 index 00000000000..9a5d5ecf373 Binary files /dev/null and b/reference/docs-conceptual/media/how-to-use-docs/previous-versions.png differ diff --git a/reference/docs-conceptual/media/how-to-use-docs/search-scope.gif b/reference/docs-conceptual/media/how-to-use-docs/search-scope.gif index ef262afde9c..953381358b7 100644 Binary files a/reference/docs-conceptual/media/how-to-use-docs/search-scope.gif and b/reference/docs-conceptual/media/how-to-use-docs/search-scope.gif differ diff --git a/reference/docs-conceptual/media/how-to-use-docs/version-search.gif b/reference/docs-conceptual/media/how-to-use-docs/version-search.gif index c95d9ca95ba..5cdcc71e613 100644 Binary files a/reference/docs-conceptual/media/how-to-use-docs/version-search.gif and b/reference/docs-conceptual/media/how-to-use-docs/version-search.gif differ