Skip to content

Commit c25f5cc

Browse files
sdwheelerDCtheGeek
authored andcommitted
Add how-to page for using docs (#4841)
* init commit * add how to page * add animation * feedback edits * fix blockquote warnings
1 parent 5d2f0ed commit c25f5cc

File tree

8 files changed

+144
-93
lines changed

8 files changed

+144
-93
lines changed

reference/docfx.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
"uhfHeaderId": "MSDocsHeader-Powershell",
9191
"apiPlatform": "powershell",
9292
"ms.devlang": "powershell",
93+
"titleSuffix": "PowerShell",
9394
"ROBOTS": "INDEX, FOLLOW",
9495
"feedback_system": "GitHub",
9596
"feedback_github_repo": "MicrosoftDocs/PowerShell-Docs",

reference/docs-conceptual/components/vscode/using-vscode.md

Lines changed: 102 additions & 90 deletions
Large diffs are not rendered by default.

reference/docs-conceptual/docfx.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@
1515
"ms.tgt_pltfr": "windows, macos, linux",
1616
"author": "sdwheeler",
1717
"ms.author": "sewhee",
18+
"titleSuffix": "PowerShell",
1819
"_op_documentIdPathDepotMapping": {
19-
"reference/docs-conceptual/wmf/": {
20+
"reference/docs-conceptual/wmf/": {
2021
"folder_relative_path_in_docset": "wmf/"
2122
}
2223
},
2324
"feedback_system": "GitHub",
24-
"feedback_github_repo": "MicrosoftDocs/PowerShell-Docs",
25-
"feedback_product_url": "https://github.com/PowerShell/PowerShell/issues/new/choose"
25+
"feedback_github_repo": "MicrosoftDocs/PowerShell-Docs",
26+
"feedback_product_url": "https://github.com/PowerShell/PowerShell/issues/new/choose"
2627
},
2728
"resource": [{
2829
"files": ["**/images/**", "**/*.png", "**/*.jpg"],
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
ms.date: 09/25/2019
3+
keywords: powershell,cmdlet
4+
title: How to use the PowerShell documentation
5+
---
6+
# How to use the PowerShell documentation
7+
8+
Welcome to the PowerShell online documentation. This site contains cmdlet reference for the
9+
following versions of PowerShell:
10+
11+
- PowerShell 7 (preview)
12+
- PowerShell 6
13+
- PowerShell 5.1
14+
- PowerShell 5.0
15+
- PowerShell 4.0
16+
- PowerShell 3.0
17+
18+
## Selecting your version
19+
20+
By default, this site displays documentation for the latest released version of PowerShell. Some
21+
cmdlets work differently in various versions of PowerShell. Be sure you are viewing the
22+
documentation for the version of PowerShell you are using.
23+
24+
Use the version picker at the top of the page to select the version of PowerShell you want.
25+
26+
![version picker](images/how-to-use-docs/picker-vall.gif)
27+
28+
## Searching for articles
29+
30+
There are two ways to search for content in Docs. The simplest way is to use the filter box under
31+
the version selector. Just enter a word that appears in the title of an article. The page displays
32+
a list of matching articles. You can also select the option to search the entire site from that
33+
list.
34+
35+
![filter box](images/how-to-use-docs/filter-search.gif)
317 KB
Loading
96.8 KB
Loading

reference/docs-conceptual/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
- name: How to use this documentation
2+
href: how-to-use-docs.md
13
- name: Overview
24
href: overview.md
35
- name: Install

0 commit comments

Comments
 (0)