Skip to content

Commit d4ac3f6

Browse files
andyleejordanandyleejordan
authored
Merge pull request PowerShell#1546 from PowerShell/andschwa/docs
Clean up documentation
2 parents d691712 + ba6b966 commit d4ac3f6

File tree

11 files changed

+270
-161
lines changed

11 files changed

+270
-161
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 183 additions & 85 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 69 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,106 @@
1-
![PowerShell Logo](assets/Powershell_64.png) PowerShell
2-
========================
1+
![logo][] PowerShell
2+
====================
33

4-
PowerShell is a task automation and configuration management platform,
5-
consisting of a command-line shell and associated scripting language built
6-
using the [.NET Command-Line Interface](https://github.com/dotnet/cli).
7-
PowerShell provides full access to COM and WMI, enabling administrators to
8-
automate administrative tasks on both local and remote Windows, Linux, and OS X systems.
4+
PowerShell is a task automation and configuration management platform.
5+
It consists of a cross-platform command-line shell and associated scripting language.
6+
7+
[logo]: assets/Powershell_64.png
98

109
New to PowerShell?
1110
------------------
12-
If you are new to PowerShell and would like to learn more, we recommend
13-
reviewing the [getting started documentation][getting-started].
14-
15-
[getting-started]: docs/learning-powerShell/learning-powershell.md
1611

17-
Build Status
18-
------------
12+
If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation.
1913

20-
| Platform | `master` |
21-
|--------------|----------|
22-
| Ubuntu 14.04 | [![Build Status](https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master)](https://travis-ci.com/PowerShell/PowerShell) |
23-
| OS X 10.11 | [![Build Status](https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master)](https://travis-ci.com/PowerShell/PowerShell) |
24-
| Windows | [![Build status](https://ci.appveyor.com/api/projects/status/jtefab3hpngtyesp/branch/master?svg=true)](https://ci.appveyor.com/project/PowerShell/powershell/branch/master) |
14+
[getting started]: docs/learning-powershell
2515

2616
Get PowerShell
2717
--------------
2818

29-
1. Download the package for your platform at [PowerShell Releases][releases].
30-
1. Install the package.
31-
* [Linux or OS X][inst-linux].
32-
* [Windows][inst-win].
19+
You can download and install a PowerShell package for any of the following platforms.
20+
21+
| Platform | Releases | How to Install |
22+
|--------------|--------------------|--------------------------------|
23+
| Windows | [.msi][rl-windows] | [How to Install][in-windows] |
24+
| Ubuntu 14.04 | [.deb][rl-ubuntu] | [How to Install][in-ubuntu] |
25+
| CentOS 7 | [.rpm][rl-centos] | [How to Install][in-centos] |
26+
| OS X 10.11 | [.pkg][rl-osx] | [How to Install][in-osx] |
27+
28+
[rl-windows]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/PowerShell_6.0.0.7.msi
29+
[rl-ubuntu]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/powershell_6.0.0-alpha.7-1_amd64.deb
30+
[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/powershell-6.0.0_alpha.7-1.x86_64.rpm
31+
[rl-osx]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/powershell-6.0.0-alpha.7.pkg
32+
33+
[installation]: docs/installation
34+
[in-windows]: docs/installation/windows.md#msi
35+
[in-ubuntu]: docs/installation/linux.md#ubuntu-1404
36+
[in-centos]: docs/installation/linux.md#centos-7
37+
[in-osx]: docs/installation/linux.md#os-x-1011
38+
39+
40+
Building the Repository
41+
-----------------------
42+
43+
| Linux | Windows | OS X |
44+
|--------------------------|----------------------------|------------------------|
45+
| [Instructions][bd-linux] | [Instructions][bd-windows] | [Instructions][bd-osx] |
46+
47+
If you have any problems building, please consult the developer [FAQ][].
48+
49+
### Build status of master branches
50+
51+
| AppVeyor (Windows) | Travis CI (Linux / OS X) |
52+
|--------------------------|--------------------------|
53+
| [![av-image][]][av-site] | [![tv-image][]][tv-site] |
3354

34-
Building PowerShell
35-
-------------------
55+
[bd-linux]: docs/building/linux.md
56+
[bd-windows]: docs/building/windows-core.md
57+
[bd-osx]: docs/building/osx.md
3658

37-
| Linux | Windows | OS X |
38-
|-------|----------|------|
39-
| [Instructions][build-linux] | [Instructions][build-wc] | [Instructions][build-osx] |
59+
[FAQ]: docs/FAQ.md
60+
61+
[tv-image]: https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master
62+
[tv-site]: https://travis-ci.com/PowerShell/PowerShell/branches
63+
[av-image]: https://ci.appveyor.com/api/projects/status/jtefab3hpngtyesp/branch/master?svg=true
64+
[av-site]: https://ci.appveyor.com/project/PowerShell/powershell/branch/master
4065

4166
Downloading the Source Code
42-
----------------------
67+
---------------------------
68+
4369
The PowerShell repository has a number of other repositories embedded as submodules.
44-
To make things easy, we can just clone recursively.
70+
71+
To make things easy, we can just clone recursively:
4572

4673
```sh
4774
git clone --recursive https://github.com/PowerShell/PowerShell.git
4875
```
4976

5077
If you already cloned but forgot to use `--recursive`, you can update submodules manually:
78+
5179
```sh
52-
git submodule init
53-
git submodule update
80+
git submodule update --init
5481
```
55-
See [working with the PowerShell repository][powershell-repo-101] for more information.
82+
83+
See [working with the PowerShell repository](docs/git) for more information.
5684

5785
Developing and Contributing
5886
--------------------------
5987

60-
Please see the [Contribution Guide][contribution] for how to develop and contribute.
61-
62-
If you encounter issues in your development, please consult the [known issues][known-issues]
63-
and [FAQ][faq] documents to see if the issue you are running into is
64-
captured and if a workaround exists.
88+
Please see the [Contribution Guide][] for how to develop and contribute.
6589

66-
If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues].
67-
If you do not see your issue captured, please file a [new issue][new-issue]. For more details see [Contributing to issues][contribution-issues].
90+
If you have any problems, please consult the [known issues][], developer [FAQ][], and [GitHub issues][].
91+
If you do not see your problem captured, please file a [new issue][] and follow the provided template.
6892

69-
PowerShell Community
70-
--------------------
71-
`TODO` Missing community details
72-
73-
Legal and Licensing
74-
-------------------
75-
76-
`TODO` Missing license details
77-
78-
`TODO` Missing link to contributor agreement
93+
[Contribution Guide]: .github/CONTRIBUTING.md
94+
[known issues]: docs/KNOWNISSUES.md
95+
[GitHub issues]: https://github.com/PowerShell/PowerShell/issues
96+
[new issue]:https://github.com/PowerShell/PowerShell/issues/new
7997

8098
Code of Conduct
8199
---------------
82100

83101
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
84-
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact
85-
[opencode@microsoft.com][conduct-email] with any additional questions or comments.
102+
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments.
86103

87-
[build-linux]: docs/building/linux.md
88-
[build-osx]: docs/building/osx.md
89-
[build-wc]: docs/building/windows-core.md
90104
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
91-
[conduct-email]: mailto:opencode@microsoft.com
92105
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
93-
[contribution]: .github/CONTRIBUTING.md
94-
[contribution-issues]: .github/CONTRIBUTING.md#contributing-to-issues
95-
[faq]: docs/FAQ.md
96-
[github-issues]:https://github.com/PowerShell/PowerShell/issues
97-
[inst-linux]: docs/installation/linux.md
98-
[inst-win]: docs/installation/windows.md
99-
[known-issues]: docs/KNOWNISSUES.md
100-
[new-issue]:https://github.com/PowerShell/PowerShell/issues/new
101-
[releases]: https://github.com/PowerShell/PowerShell/releases
102-
[powershell-repo-101]: docs/git/powershell-repository-101.md
106+
[conduct-email]: mailto:opencode@microsoft.com

docs/git/powershell-repository-101.md renamed to docs/git/README.md

File renamed without changes.

docs/learning-powerShell/learning-powershell.md renamed to docs/learning-powershell/README.md

File renamed without changes.

docs/learning-powerShell/debugging-from-commandline.md renamed to docs/learning-powershell/debugging-from-commandline.md

File renamed without changes.

docs/learning-powerShell/powershell-beginners-guide.md renamed to docs/learning-powershell/powershell-beginners-guide.md

File renamed without changes.

docs/learning-powerShell/using-ise.md renamed to docs/learning-powershell/using-ise.md

File renamed without changes.

docs/learning-powerShell/using-vscode.md renamed to docs/learning-powershell/using-vscode.md

File renamed without changes.

docs/learning-powerShell/vscode.png renamed to docs/learning-powershell/vscode.png

File renamed without changes.

docs/maintainers/maintainers.md renamed to docs/maintainers/README.md

File renamed without changes.

0 commit comments

Comments
 (0)