Skip to content

Merging latest updates into Live #1908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 75 commits into from
Dec 1, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
2a3ccf3
Update the example of `Where-Object -IsNot` (#1841)
matt9ucci Nov 7, 2017
f778a37
Update Example 5 in Group-Object.md (#1845)
matt9ucci Nov 8, 2017
1357977
removing @{Text=} tags
Nov 7, 2017
efba651
fixing UTF8 characters
Nov 7, 2017
b93a6ba
removed empty H3
Nov 7, 2017
ec505bf
added H3 for input and output types
Nov 7, 2017
c2abb44
removed mangled UTF8 character
Nov 8, 2017
bbffd77
updating Out-* commands with -NoNewLine per Issue 1739
Nov 9, 2017
2bdb9e6
Fix the example of `Format-Table -DisplayError` (#1848)
matt9ucci Nov 9, 2017
61cb77d
Fix the example of `Format-Wide -DisplayError` (#1850)
matt9ucci Nov 10, 2017
882b0e8
Fix the example of `Format-Custom -DisplayError` (#1849)
matt9ucci Nov 10, 2017
67db02a
updating set-acl docs per PR#901
Nov 7, 2017
9799c2b
using semantic link breaks
Nov 10, 2017
a5f21c5
Fix the example of `Format-Wide -ShowError` (#1851)
matt9ucci Nov 13, 2017
9467262
Fixed Test-ScriptFileInfo example (#1852)
alan-null Nov 13, 2017
b5d12a3
fixing issue 1768
Nov 7, 2017
b04197f
Formatting, example fix for Body parameter (#1847)
ebrucucen Nov 13, 2017
b6b156a
fixing style consistency across articles
Nov 13, 2017
e03a354
fixing conflicts
Nov 13, 2017
07b21b0
Fix example numbers in Resume-Job.md (#1857)
matt9ucci Nov 14, 2017
348ed70
Fixes typo $WebSiteName in separatingEnvData.md (#1856)
DexterPOSH Nov 14, 2017
b04a75a
Updates configurations.md (#1855)
DexterPOSH Nov 14, 2017
484d598
Fix typo in comment (#1854)
ciriarte Nov 14, 2017
e46d3a1
Merge pull request #1846 from sdwheeler/sdw-issue1739
zjalexander Nov 14, 2017
f42a62f
Updating the help content for v6. (#1853)
adityapatwardhan Nov 15, 2017
eade8e4
Fix example numbers in about_Transactions.md (#1859)
matt9ucci Nov 15, 2017
518fde2
Update Alias-Provider.md (#1831)
doctordns Nov 15, 2017
248e283
Add documentation of new -AsHashtable switch for ConvertFrom-Json int…
bergmeister Nov 15, 2017
bcedaf0
Fix example numbers in Invoke-WebRequest.md (#1862)
matt9ucci Nov 16, 2017
8e4ac81
Merge branch 'live' into staging
Nov 16, 2017
1f54577
reformatting and integrating changes from PR#1831 (#1860)
Nov 16, 2017
aeeb091
Fix example numbers in Get-Help.md (#1869)
matt9ucci Nov 17, 2017
83b1241
Fix example numbers in Import-Module.md (#1868)
matt9ucci Nov 17, 2017
99be9ad
Fix example number in ConvertTo-Html.html (#1867)
matt9ucci Nov 17, 2017
919d940
Update dscCiCd.md (#1865)
tomlarse Nov 17, 2017
cb00730
Web Cmdlets 6.0.0 Documentation Refresh (#1870)
markekraus Nov 18, 2017
6e31c85
Merge Example 4 and 5 in Get-Member.md (#1874)
matt9ucci Nov 18, 2017
cc018bf
Remove hash algorithms unsupported in v6.0 (#1873)
matt9ucci Nov 19, 2017
b98aa67
Update outputs of Get-Verb (#1872)
matt9ucci Nov 19, 2017
1b2889e
Fix typo in ConvertTo-Html.md (UTF-x) (#1879)
matt9ucci Nov 20, 2017
4fec39b
Fix "Accept wildcard characters" in Get-Service.md v6 (#1878)
matt9ucci Nov 20, 2017
061245d
Fixed Get-WindowsFeature cmdlet HyperLink (#1877)
keeratsingh Nov 20, 2017
496832f
Update Get-WinEvent.md (#1876)
doctordns Nov 20, 2017
c644c38
Update Example 8 in Get-Process.md (find the owner of a process) (#1875)
matt9ucci Nov 20, 2017
58b15dd
updated localmachine\Root to LocalMachine\My (#1880)
rchaganti Nov 20, 2017
69c037d
Update Group property example in Get-Verb.md (#1881)
matt9ucci Nov 21, 2017
d69465e
adding missing space (#1885)
mairaw Nov 21, 2017
a066c77
removing stray character (#1886)
mairaw Nov 21, 2017
bf70ac9
Update Example 9 in Get-Process.md (#1888)
matt9ucci Nov 22, 2017
6687a84
Remove "About ISE" files of v6.0 (#1891)
matt9ucci Nov 27, 2017
23afc78
Update Get-Process.md (#1890)
doctordns Nov 27, 2017
5a8d5f4
Update productincompat.md (#1892)
Cloud-Writer Nov 27, 2017
46d7c99
Update unapproved verbs examples in Get-Verb.md (#1896)
matt9ucci Nov 28, 2017
a88c947
Removing extra space in the Example 5A script (#1894)
vrnithinkumar Nov 28, 2017
a2d0e9b
fixing merge conflict
Nov 28, 2017
f0f0da0
resolving conflict
Nov 28, 2017
d395d0e
updates to style and contrib
Nov 16, 2017
d4d446d
tweak format
Nov 16, 2017
67ad296
tweak format 2
Nov 16, 2017
7883844
fix typo
Nov 16, 2017
b4877f3
fix number list example
Nov 16, 2017
9e6ebd0
adding review feedback
Nov 22, 2017
323e325
fix broken links
Nov 22, 2017
e6b4a53
incorporating feedback from zach
Nov 27, 2017
7514fcf
reformatting About_* for 80 columns - part 1
Nov 27, 2017
66ecafd
reformat about_*
Nov 28, 2017
56dc2df
reformatting About_* topics - Part 2
Nov 28, 2017
d310e14
fixing broken links
Nov 28, 2017
e084dc5
fixing more broken links
Nov 28, 2017
05ff294
more broken links fixed
Nov 28, 2017
a935671
Fix parameter's position in Get-Random.md (#1901)
matt9ucci Nov 29, 2017
9040d65
Fix parameter's position in Measure-Command.md (#1905)
matt9ucci Nov 30, 2017
c715ab2
Fix parameter's position in Trace-Command.md (#1904)
matt9ucci Nov 30, 2017
6824d85
Actually call the configuration in the example (#1906)
charlesbihis Nov 30, 2017
cece485
reformatting About_* for 80 columns - part 3 (#1902)
Nov 30, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 7 additions & 106 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,108 +1,9 @@
# Contributing to PowerShell Documentation
# Contributor Guide

Thank you for your interest in PowerShell documentation!
See below for details on how you can contribute to our technical documentation.
Thank you for your interest in contributing to quality documentations.
As an open source project, we welcome input and updates from the community.
The following topics explain how to contribute to the PowerShell documentation.

>For general information about getting started with Git and GitHub, see [GitHub Help](https://help.github.com/).

## Sign a CLA

Before you can contribute to any PowerShell repositories, you must [sign a Microsoft Contribution Licensing Agreement (CLA)](https://cla.microsoft.com/).
If you've already contributed to PowerShell repositories in the past, congratulations!
You've already completed this step.

## Providing feedback on PowerShell documentation

You can point out errors, suggest changes, or request new topics by [creating an issue](https://help.github.com/articles/creating-an-issue/) on the
[PowerShell-Docs repository issues page](https://github.com/PowerShell/PowerShell-Docs/issues).

Issues are reviewed regularly by members of the PowerShell documentation team, and are triaged, assigned, and addressed accordingly.

## Writing PowerShell documentation

One of the easiest ways to contribute to PowerShell is by helping to write and edit documentation.
All of our documentation hosted on GitHub is written using [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/).

## Making minor edits to existing topics

To [edit an existing file](https://help.github.com/articles/editing-files-in-another-user-s-repository/), simply navigate to it and click the "Edit" button.
GitHub will automatically create your own fork of our repository where you can make your changes.
Once you're finished, save your edits and submit a [pull request](https://help.github.com/articles/creating-a-pull-request/) to the *staging* branch of the [PowerShell-Docs](https://github.com/PowerShell/PowerShell-Docs) repository.
After your pull request is created, someone on the PowerShell documentation team will review your changes before merging them into the *staging* branch.

## Making major edits to existing topics

If you are making substantial changes to an existing article, adding or changing images, or contributing a new article, you will need to manually create your GitHub fork, then clone the fork down to your local computer.
A fork is a GitHub-based replica of the main repository, under your GitHub account, which provides you with a working copy which you can use in isolation.
You will create pull requests from your fork.
Similarly, a clone is a local-based replica of the repository which, in this case, will be a clone of your fork.
The clone allows you to work on Git repositories offline, and using more powerful native software/tools.

Here is the workflow for making major edits to existing documentation:

1. [Create a fork](https://help.github.com/articles/fork-a-repo/) of the [PowerShell-Docs](https://github.com/PowerShell/PowerShell-Docs) repository.
2. [Create a clone of your fork](https://help.github.com/articles/cloning-a-repository/) on your local computer.
3. Create a new local branch in your cloned repository.
4. Make changes to the file(s) you want to update in a Markdown editor.
See below for commonly used Markdown editors.
5. [Push your local branch](https://help.github.com/articles/pushing-to-a-remote/) to your fork.
6. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/) to the *staging* branch of the [PowerShell-Docs](https://github.com/PowerShell/PowerShell-Docs) repository.

## Creating new topics

If you want to contribute new documentation, first check for [issues tagged as "in progress"](https://github.com/PowerShell/PowerShell-Docs/labels/in%20progress) to make sure you're not duplicating efforts.
If no one seems to be working on what you have planned:

* Open a new issue and label it as "in progress" (if you are a member of the PowerShell organization) or add "in progress" as a comment to tell others what you're working on
* Follow the same workflow as described above for making major edits to existing topics.
* Edit the `TOC.md` topic (located in the top-level folder for each documentation set) to add your new topics to the table of contents.
Determine where your new topic belongs in the table of contents, and add a heading of the appropriate level, with a link to your topic (`[My topic title](relative path to my topic)`).

## Markdown editors

Here are some Markdown editors you can try out:

* [Visual Studio Code](https://code.visualstudio.com)
* [Markdown Pad](http://markdownpad.com/)
* [Atom](https://atom.io/)
* [Sublime Text](http://www.sublimetext.com/)


## GitHub Flavored Markdown (GFM)

All of the articles in this repository use [GitHub Flavored Markdown (GFM)](https://help.github.com/articles/github-flavored-markdown/).

Some of the basic GFM syntax includes:

* **Line breaks vs. paragraphs:** In Markdown there is no HTML `<br />` or `<p />` element.
Instead, a new paragraph is designated by an empty line between two blocks of text.

> **Note**: Please add a single newline after each sentence to simplify the command-line output of diffs and history.
This is not currently adopted across all of PowerShell-Docs, but we will be working towards it over time.
Feel free to help out.

* **Italics:** The HTML `<em>some text</em>` element is written as `*some text*`
* **Bold:** The HTML `<strong>some text</strong>` element is written as `**some text**`
* **Headings:** HTML headings are designated using `#` characters at the start of the line.
The number of `#` characters corresponds to the hierarchical level of the heading (for example, `#` = `<h1>` and `###` = ```<h3>```).
* **Numbered lists:** To make a numbered (ordered) list start the line with `1. `.
If you want multiple elements within a single list element, format your list as follows:
```
1. For the first element (like this one), insert a tab stop after the 1.

To include a second element (like this one), insert a line break after the first and align indentations.
```
to get this output:

1. For the first element (like this one), insert a tab stop after the 1.

To include a second element (like this one), insert a line break after the first and align indentations.

* **Bulleted lists:** Bulleted (unordered) lists are almost identical to ordered lists except that the `1. ` is replaced with either `* `, `- `, or `+ `.
Multiple element lists work the same way as with ordered lists.
* **Links:** The syntax for a hyperlink is `[visible link text](link URL)`.
* **Link to another topic within the same docset:** A docset is a top-level folder in this repository
(for example, "dsc", "scripting").
The syntax for a hyperlink to a topic within the same docset is `[topic title](relative path to topic)`.
For more information, see [Relative links in READMEs](https://help.github.com/articles/relative-links-in-readmes/).
To link to a topic in a different top-level folder, use the URL of the published page, as described above.
1. [Get started](./contributing/GETSTARTED.md)
2. [Writing PowerShell documentation](./contributing/WRITING.md)
3. [Style Guide](./contributing/STYLE.md)
93 changes: 0 additions & 93 deletions STYLE.md

This file was deleted.

67 changes: 67 additions & 0 deletions contributing/GETSTARTED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Contributing to PowerShell Documentation

Thank you for your interest in PowerShell documentation!
See below for details on how you can contribute to our technical documentation.

>For general information about getting started with Git and GitHub, see [GitHub Help][git-help].

## Sign a CLA

Before you can contribute to any PowerShell repositories, you must sign a
[Microsoft Contribution Licensing Agreement (CLA)][cla].
If you've already contributed to PowerShell repositories in the past, congratulations!
You've already completed this step.

## Providing feedback on PowerShell documentation

You can point out errors, suggest changes, or request new topics by [creating an issue][new-issue]
on the [PowerShell-Docs repository issues page][doc-issues].

Issues are reviewed regularly by members of the PowerShell documentation team.
The issues are triaged, assigned, and addressed accordingly.

## Making minor edits to existing topics

To [edit an existing file][edit-file], simply navigate to it and click the "Edit" button.
GitHub will automatically create your own fork of our repository where you can make your changes.
Once you're finished, save your edits and submit a [pull request][pull] to the *staging* branch
of the [PowerShell-Docs][docs-repo] repository.
After your pull request is created, someone on the PowerShell documentation team reviews your changes
before merging them into the *staging* branch.

## Making major edits to existing topics

If you are making substantial changes to an existing article, adding or changing images,
or contributing a new article, you will need to manually create your GitHub fork,
then clone the fork down to your local computer.
A fork is a GitHub-based replica of the main repository, under your GitHub account,
that provides you with a working copy which you can use in isolation.
You will create pull requests from your fork.
Similarly, a clone is a local-based replica of the repository which, in this case, will be a clone of your fork.
The clone allows you to work on Git repositories offline, and using more powerful native software/tools.

Here is the workflow for making major edits to existing documentation:

1. [Create a fork][fork] of the [PowerShell-Docs][docs-repo] repository.
2. [Create a clone of your fork][clone] on your local computer.
3. Create a new local branch in your cloned repository.
4. Make changes to the file(s) you want to update in a Markdown editor.
5. [Push your local branch][push] to your fork.
6. [Create a pull request][pull] to the *staging* branch of the [PowerShell-Docs][docs-repo] repository.


## Next steps

See [Writing PowerShell documentation](WRITING.md).

<!-- External URLs -->
[git-help]: https://help.github.com/
[cla]: https://cla.microsoft.com/
[new-issue]: https://help.github.com/articles/creating-an-issue/
[doc-issues]: https://github.com/PowerShell/PowerShell-Docs/issues
[edit-file]: https://help.github.com/articles/editing-files-in-another-user-s-repository/
[docs-repo]: https://github.com/PowerShell/PowerShell-Docs
[fork]: https://help.github.com/articles/fork-a-repo/
[clone]: https://help.github.com/articles/cloning-a-repository/
[push]: https://help.github.com/articles/pushing-to-a-remote/
[pull]: https://help.github.com/articles/creating-a-pull-request/
Loading