Skip to content

Commit e27d9c8

Browse files
committed
Add info to README.
1 parent a764c0c commit e27d9c8

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,9 @@ https://github.com/MicrosoftDocs/office-docs-powershell/graphs/contributors
222222
Don't forget to ~~brag~~ share on social media!
223223
Sharing helps sustain the community and advertises to others to contribute to the open source content as well!
224224

225-
226225
# Generate Your Own Markdown
227226
**SECTION IN PROGRESS**
227+
Use PlatyPS to generate Markdown. See, https://github.com/PowerShell/platyPS.
228228

229229
## Install PlatyPS.
230230
**SECTION IN PROGRESS**
@@ -236,4 +236,23 @@ Sharing helps sustain the community and advertises to others to contribute to th
236236
**SECTION IN PROGRESS**
237237

238238
## If you want to merge multiple versions into a single version then use the PlatyPS merge command.
239-
**SECTION IN PROGRESS**
239+
**SECTION IN PROGRESS**
240+
241+
242+
# Frequently Asked Questions
243+
* When will my content go live?
244+
When you submit a Pull Request it goes through a validation check and the results are shown on the Pull Request page in GitHub.
245+
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.
247+
Unfortunately the review site requires a Microsoft login at this time.
248+
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.
249+
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.
251+
There is not a set schedule for this to happen but the maintainers are good about doing this fairly quickly.
252+
253+
* When does the GitHub content show up in the products with Get-Help?
254+
The one source of truth for Office PowerShell cmdlets is the GitHub repository.
255+
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.
256+
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.

0 commit comments

Comments
 (0)