Skip to content

Commit 36ac28a

Browse files
committed
add to FAQ on readme.
1 parent ffddd73 commit 36ac28a

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,4 +258,44 @@ When a product team ships an update or new version they can use the PlatyPS tool
258258

259259
The XML contains the latest version of the reference content on GitHub.
260260
Ideally the Online versions will always have the latest content from GitHub and the On Premises products will always have the latest help with Update-Help.
261-
The work to make this happen is not yet done so the content is only refreshed on product team releases.
261+
The work to make this happen is not yet done so the content is only refreshed on product team releases.
262+
263+
## What metadata do reference topics need to have?
264+
265+
Every cmdlet reference topic needs at least the following in the metadata field at the top of the reference article:
266+
267+
```
268+
external help file:
269+
applicable: Skype for Business Server 2015
270+
title: Add-CsSlaDelegates
271+
schema: 2.0.0
272+
```
273+
The *external help file* tag is for the docs.microsoft.com infrastructure.
274+
It can be empty but without it the build will fail.
275+
276+
The *applicable* tag is so that when PlatyPS is run to generate the XML that goes in the product it can only pull help content for specific product versions.
277+
Every applicable tag is located in the [Applicable Tags](https://github.com/MicrosoftDocs/office-docs-powershell/wiki/Applicable-Tags) wiki page.
278+
These tags have to be added to the docs.microsoft.com infrastructure.
279+
If you try to include a tag that has not been added then the build will fail.
280+
281+
The *title* tag is for metrics. More information about metrics coming.
282+
283+
The *schema* tag let's the build system know what schema to use.
284+
The 2.0.0 is the only supported schema currently.
285+
The schema can be viewed on the PlatyPS site, see https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md.
286+
287+
## What is the special Table of Contents (TOC) file all about?
288+
289+
Every folder has a special file that is a table of contents for all the files in the folder.
290+
291+
Some examples are:
292+
* Teams: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/teams.md
293+
* Skype: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/skype.md
294+
* SharePoint Server: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md
295+
296+
Every folder must have this TOC file.
297+
When you browse the list of cmdlets in the Reference folder this is the file you see.
298+
For example, https://docs.microsoft.com/en-us/powershell/module/skype/?view=skype-ps.
299+
Note that docs.microsoft.com automatically strips out the note about manually entering a description.
300+
It ONLY strips this out if it is in the exact format given.
301+
Any slight deviation from the format and it won't strip it out and you will see that "manually enter description" text.

0 commit comments

Comments
 (0)