Skip to content

Commit d0a3fce

Browse files
authored
Migrate hub and landing pages from docs-powershell (#4863)
* Migrate hub and landing pages from docs-powershell * add new files to publishing config in docfx * change dest folder * fix typo in docfx for digit-art.md * exclude new folders from build script
1 parent f996be7 commit d0a3fce

File tree

11 files changed

+453
-4
lines changed

11 files changed

+453
-4
lines changed

build.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ $ReferenceDocset = Join-Path $PSScriptRoot 'reference'
3232

3333
# Go through all the directories in the reference folder
3434
$jobs = [System.Collections.Generic.List[object]]::new()
35-
$excludeList = 'docs-conceptual', 'mapping', 'bread', '7'
35+
$excludeList = 'module', 'media', 'docs-conceptual', 'mapping', 'bread', '7'
3636
Get-ChildItem $ReferenceDocset -Directory -Exclude $excludeList | ForEach-Object -Process {
3737
$job = Start-ThreadJob -Name $_.Name -ArgumentList @($SkipCabs,$pandocExePath,$PSScriptRoot,$_) -ScriptBlock {
3838
param($SkipCabs, $pandocExePath, $WorkingDirectory, $DocSet)

reference/digital-art.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
author: sdwheeler
3+
ms.author: sewhee
4+
ms.date: 09/04/2019
5+
title: PowerShell Digital Art
6+
---
7+
# PowerShell Digital Art
8+
9+
*The legends are true! The powerful shell that will ensure safe passage to the cloud. But how?*
10+
11+
Please enjoy the digital artwork linked below. Demonstrate to your peers that *you have been entrusted with the Scrolls of Monad!*
12+
13+
## Comic
14+
15+
- [PowerShell Hero Comic (High resolution)](https://aka.ms/powershellherocomic_highres)
16+
- [PowerShell Hero Comic (Print resolution)](https://aka.ms/powershellherocomic_print)
17+
- [PowerShell Hero Comic (Web resolution)](http://aka.ms/powershellherocomic_web)
18+
19+
To share a link to the comic, you can also use <http://aka.ms/powershellcomic>, which will redirect to the Web resolution file.
20+
21+
## Wallpaper
22+
23+
- [PowerShell Hero Comic Wallpaper (4k resolution)](http://aka.ms/powershellherowallpaper)
24+
- [PowerShell Hero Pink Wallpaper (4k resolution)](http://aka.ms/powershellherowallpaper1)
25+
- [PowerShell Hero White Wallpaper (4k resolution)](http://aka.ms/powershellherowallpaper2)
26+
27+
## Poster
28+
29+
- [PowerShell Hero Poster](http://aka.ms/powershellheroposter)
30+
31+
## PowerShell Hero
32+
33+
- [PowerShell Hero Image](http://aka.ms/powershellhero)
34+
35+
### Microsoft PowerShell Logo and Digital Art Guidelines
36+
37+
As a general rule, third parties may not use Microsoft logos and artwork without permission. The
38+
following are the limited circumstances under which third parties may use the Microsoft PowerShell
39+
logo and artwork.
40+
41+
- For non-commercial purposes (documentation or on a website) that reference your connection with
42+
Microsoft PowerShell.
43+
44+
Any uses outside of these guidelines as determined by Microsoft is strictly prohibited. Do not use
45+
the Microsoft PowerShell logo or artwork in products, product packaging, or other business services
46+
for which a formal license is required.
47+
48+
Microsoft reserves the right in its sole discretion to terminate or modify permission to display
49+
the logo or artwork, and may request that third parties modify or delete any use of the logo or
50+
artwork that, in Microsoft's sole judgment, does not comply with these guidelines or might
51+
otherwise impair Microsoft's rights in the logo.

reference/docfx.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
{
22
"build": {
33
"content": [
4+
{
5+
"files": ["index.yml", "module/index.md","digital-art.md"],
6+
"exclude": ["**/obj/**", "**/includes/**", "README.md"],
7+
"dest": ""
8+
},
9+
410
{ "files": ["bread/toc.yml"], "dest": "scripting" },
511

612
{ "files": ["toc.yml"], "src": "docs-conceptual", "version": "powershell-3.0", "dest": "scripting/powershell-3.0" },
@@ -37,6 +43,10 @@
3743
{ "files": ["**/*.md"], "src": "virtual-directory-module", "dest": "module" }
3844
],
3945
"resource": [
46+
{
47+
"files": ["**/media/**/*.png", "**/media/**/*.gif", "**/media/**/*.jpeg", "**/media/**/*.jpg", "**/media/**/*.svg"],
48+
"exclude": ["**/obj/**", "**/includes/**"]
49+
},
4050
{
4151
"files": ["**/images/**", "**/*.png", "**/*.gif", "**/*.jpeg", "**/*.jpg", "**/*.svg"],
4252
"exclude": ["**/obj/**", "**/includes/**"]

reference/index.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

reference/index.yml

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
### YamlMime:Hub
2+
3+
title: PowerShell Documentation
4+
summary: Official product documentation for PowerShell
5+
brand: windows
6+
7+
metadata:
8+
title: PowerShell Documentation
9+
ms.topic: hub-page # Required
10+
ms.collection: collection
11+
author: sdwheeler
12+
ms.author: sewhee
13+
ms.date: 09/04/2019
14+
15+
# highlightedContent section (optional)
16+
# Maximum of 8 items
17+
highlightedContent:
18+
# itemType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
19+
items:
20+
# Card
21+
- title: Overview
22+
itemType: get-started
23+
url: https://docs.microsoft.com/powershell/scripting/overview
24+
# Card
25+
- title: Setup and installation
26+
itemType: download
27+
url: https://docs.microsoft.com/powershell/scripting/install/installing-powershell
28+
# Card
29+
- title: Sample scripts
30+
itemType: how-to-guide
31+
url: https://docs.microsoft.com/powershell/scripting/samples/sample-scripts-for-administration
32+
# Card
33+
- title: PowerShell Gallery
34+
itemType: deploy
35+
url: http://www.powershellgallery.com/
36+
# Card
37+
- title: PowerShell Module Browser
38+
itemType: reference
39+
url: https://docs.microsoft.com/powershell/module/
40+
# Card
41+
- title: PowerShell on GitHub
42+
itemType: architecture
43+
url: https://github.com/PowerShell/PowerShell
44+
45+
# productDirectory section (optional)
46+
productDirectory:
47+
title: PowerShell Editions + Tools
48+
summary: Available editions, tools, and technology that supports PowerShell # < 160 chars (optional)
49+
items:
50+
# Card 1
51+
- title: PowerShell 5.1
52+
# imageSrc should be square in ratio with no whitespace
53+
imageSrc: ./media/index/powershell_128.svg
54+
links:
55+
- url: https://docs.microsoft.com/powershell/scripting/install/installing-windows-powershell
56+
text: Install Windows PowerShell
57+
- url: https://docs.microsoft.com/powershell/scripting/whats-new/what-s-new-in-windows-powershell-50
58+
text: What's new in PowerShell 5.x
59+
# Card 2
60+
- title: PowerShell Core
61+
imageSrc: ./media/index/ps_black_128.svg
62+
links:
63+
- url: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows
64+
text: Install PowerShell Core on Windows
65+
- url: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux
66+
text: Install PowerShell Core on Linux
67+
- url: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-macos
68+
text: Install PowerShell Core on macOS
69+
- url: https://docs.microsoft.com/powershell/scripting/whats-new/what-s-new-in-powershell-core-62
70+
text: What's new in PowerShell 6.2
71+
# Card 3
72+
- title: PowerShell Gallery
73+
imageSrc: ./media/index/avatar_128.svg
74+
links:
75+
- url: https://www.powershellgallery.com/
76+
text: PowerShell Gallery
77+
- url: https://docs.microsoft.com/powershell/gallery/overview
78+
text: What is the PowerShell Gallery
79+
- url: https://docs.microsoft.com/powershell/gallery/concepts/publishing-guidelines
80+
text: Best practices
81+
- url: https://docs.microsoft.com/powershell/gallery/faqs
82+
text: FAQs
83+
# Card 4
84+
- title: PowerShell DSC
85+
imageSrc: https://docs.microsoft.com/media/common/i_config-tools.svg
86+
links:
87+
- url: https://docs.microsoft.com/powershell/dsc/overview/overview
88+
text: DSC Overview
89+
- url: https://docs.microsoft.com/powershell/dsc/getting-started/lnxgettingstarted
90+
text: Get started with DSC for Linux
91+
- url: https://dsccommunity.org/
92+
text: DSC Community
93+
# Card 5
94+
- title: Developer resources
95+
imageSrc: https://docs.microsoft.com/media/common/i_code-edit.svg
96+
links:
97+
- url: https://docs.microsoft.com/powershell/developer
98+
text: PowerShell SDK documentation
99+
- url: https://docs.microsoft.com/dotnet/api/?view=pscore-6.2.0
100+
text: PowerShell Core SDK 6.2.0 API reference
101+
- url: https://code.visualstudio.com/docs/languages/powershell
102+
text: Visual Studio Code PowerShell Extension
103+
- url: https://docs.microsoft.com/powershell/scripting/components/vscode/using-vscode-for-remote-editing-and-debugging
104+
text: Using VSCode for remote editing and debugging
105+
# Card 6
106+
- title: Related technologies
107+
imageSrc: https://docs.microsoft.com/media/common/i_tools.svg
108+
links:
109+
- url: https://docs.microsoft.com/powershell/wmf/
110+
text: Windows Management Framework
111+
- url: https://docs.microsoft.com/powershell/windows/get-started?view=win10-ps
112+
text: PowerShell modules to manage Windows
113+
- url: https://aka.ms/cloudshell/powershell-docs
114+
text: PowerShell in Azure Cloud Shell
115+
- url: https://docs.microsoft.com/powershell/azure/overview
116+
text: Azure PowerShell
117+
- url: https://docs.microsoft.com/azure/automation/automation-runbook-types
118+
text: Azure Automation runbooks
119+
- url: https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-powershell
120+
text: Azure Functions using PowerShell
121+
122+
tools:
123+
title: Community Resources # < 60 chars (optional)
124+
summary: Connect with other PowerShell users
125+
items:
126+
# Card 1
127+
- title: User Groups
128+
imageSrc: https://docs.microsoft.com/media/hubs/powershell/i_group.svg
129+
url: https://aka.ms/psusergroup
130+
# Card 2
131+
- title: TechNet Forums
132+
imageSrc: https://docs.microsoft.com/media/hubs/powershell/i_group-feedback.svg
133+
url: https://social.technet.microsoft.com/forums/home?forum=winserverpowershell
134+
# Card 3
135+
- title: DSC Community
136+
imageSrc: https://docs.microsoft.com/media/hubs/powershell/i_group-feedback.svg
137+
url: https://dsccommunity.org/
138+
# Card 4
139+
- title: PowerShell.org
140+
imageSrc: https://docs.microsoft.com/media/hubs/powershell/i_group-feedback.svg
141+
url: https://powershell.org/
142+
# Card 5
143+
- title: StackOverFlow
144+
imageSrc: https://docs.microsoft.com/media/hubs/powershell/logo_stackoverflow.svg
145+
url: https://stackoverflow.com/questions/tagged/powershell
146+
# Card 6
147+
- title: r/PowerShell
148+
imageSrc: https://docs.microsoft.com/media/hubs/powershell/logo_reddit.svg
149+
url: https://www.reddit.com/r/PowerShell/
150+
# Card 7
151+
- title: PowerShell Slack
152+
imageSrc: https://docs.microsoft.com/media/logos/logo-slack.svg
153+
url: http://poshcode.org/slack
154+
# Card 8
155+
- title: PowerShell Discord
156+
imageSrc: ./media/index/discord.svg
157+
url: http://poshcode.org/discord
158+
# Card 9
159+
- title: Digital Art
160+
imageSrc: https://docs.microsoft.com/media/hubs/powershell/i_digital-art.svg
161+
url: digital-art.md
162+
163+
additionalContent:
164+
# Supports up to 3 sections
165+
sections:
166+
- title: PowerShell Team # < 60 chars (optional)
167+
summary: Communicate with the PowerShell team # < 160 chars (optional)
168+
items:
169+
# Card 1
170+
- title: Official PowerShell Blog
171+
summary: Official news and announcements
172+
url: https://devblogs.microsoft.com/powershell/
173+
# Card 2
174+
- title: PowerShell Team on Twitter
175+
summary: PowerShell news 280 characters at a time
176+
url: https://twitter.com/PowerShell_Team
177+
# Card 3
178+
- title: PowerShell UserVoice
179+
summary: The place for bugs in Windows PowerShell
180+
url: https://windowsserver.uservoice.com/forums/301869-powershell
181+
# Card 4
182+
- title: GitHub Issues
183+
summary: The place for bugs in the current release
184+
url: https://github.com/powershell/powershell/issues
185+
# Card 5
186+
- title: Hey, Scripting Guy! Blog
187+
summary: A place to learn about PowerShell and share stories of automation
188+
url: https://devblogs.microsoft.com/scripting/
Lines changed: 35 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)