Skip to content

Commit a4fc6f6

Browse files
committed
adjust readme formatting.
1 parent 4da950a commit a4fc6f6

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -240,19 +240,25 @@ Use PlatyPS to generate Markdown. See, https://github.com/PowerShell/platyPS.
240240

241241

242242
# Frequently Asked Questions
243-
* When will my content go live?
243+
244+
## When will my content go live?
245+
244246
When you submit a Pull Request it goes through a validation check and the results are shown on the Pull Request page in GitHub.
245247
Once the checks are completed, and there are no errors or warnings, and the appropriate sign off has been completed by the product team, a GitHub maintainer will merged the Pull Request into the Master branch on GitHub.
246-
A site located at review.docs.microsoft.com shows a mirror of the docs.microsoft.com.
248+
249+
A site located at review.docs.microsoft.com shows a mirror of the docs.microsoft.com and pulls from the Review branch.
247250
Unfortunately the review site requires a Microsoft login at this time.
248251
This review site provides an opportunity for Microsoft product teams, support, and other internal stakeholders to review any changes before they are pushed to the live site.
249252

250-
The next step is for a GitHub maintainer to merge the Master branch into the Live branch. Once this is complete the Pull Request will go live and show up on docs.microsoft.com.
253+
The next step is for a GitHub maintainer to merge the Master branch into the Live branch.
254+
Once this is complete the changes in the Pull Request will show up on docs.microsoft.com (docs.microsoft.com pulls its content from the Live branch).
251255
There is not a set schedule for this to happen but the maintainers are good about doing this fairly quickly.
252256

253-
* When does the GitHub content show up in the products with Get-Help?
257+
## When does the GitHub content show up in the products with Get-Help?
258+
254259
The one source of truth for Office PowerShell cmdlets is the GitHub repository.
255260
When a product team ships an update or new version they can use the PlatyPS tool to generate XML and add that to the release.
261+
256262
The XML contains the latest version of the reference content on GitHub.
257-
Ideally I would like to have the Online versions always have the latest content from GitHub and the On Premises products always have the latest help with Update-Help.
258-
Current I am not done with this work yet so the content is only refreshed on product team releases.
263+
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.
264+
The work to make this happen is not yet done so the content is only refreshed on product team releases.

0 commit comments

Comments
 (0)