Skip to content

Commit

Permalink
merged in TP3
Browse files Browse the repository at this point in the history
  • Loading branch information
scooley committed Nov 12, 2015
2 parents 85db213 + d98c877 commit 7818303
Show file tree
Hide file tree
Showing 68 changed files with 15,564 additions and 6 deletions.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
50 changes: 44 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,45 @@
# Windows-Container-Documentation-Private
Documents for Windows Server and Hyper-V Containers...
# Virtualization-Documentation
Place to store our documentation, code samples, etc for public consumption and contributions.

## Helpful links
* [OP Publication Portal](https://op-portal-prod.azurewebsites.net/#/containers/repository/repositories/All)
* [internal preview of the master branch](https://int.msdn.microsoft.com/virtualization/windowscontainers/containers_welcome?branch=TP4Stage)
* [Sandbox with branch switcher](https://msdnnext.redmond.corp.microsoft.com/en-us/virtualization/windowscontainers/containers_welcome?branch=TP4Stage)
## Contribute
To contribute, fork the project and submit a pull request! Here's [our wishlist](./TODO.md).

Digging into the repo structure a little:

### doc-site
This is a mirrored copy of the documentation available on the [msdn virtualization site](https://msdn.microsoft.com/virtualization).

Folders you can add to:
* **virtualization** -- Contribute here! --
This folder contains all of the markdown for the docs!

The folder structure matched the URL structure for the website.

**For example: ** Say you want to edit the user guide article for working with checkpoints.
msdn location: [https://msdn.microsoft.com/virtualization/hyperv_on_windows/user_guide/checkpoints](https://msdn.microsoft.com/virtualization/hyperv_on_windows/user_guide/checkpoints)
doc location:
doc-site/virtualization/hyperv_on_windows/user_guide/checkpoints.md

If you add a screen shot or picture, put it in the media folder closest to the article you're contributing to. For the checkpoints userguide, that would be:
doc-site/virtualization/hyperv_on_windows/user_guide/media

* media -- shared media for the main landing page
Chances are you aren't adding pictures to the landing page but, if you were, they would be in here.

Folders you don't care about -- _I will not review pull requests that modify any of these folders._ All of their contents are for doc parsing robots only.
* Hyper-V -- contains git config information for the docs
* Tools -- site building tools


### demos
Demos of Hyper-V. These are public scripts from various presentations and conferences.

Everything in here was made to present once. There are many agregious hacks. Don't use any of it in production.

### *-samples
Walkthroughs and samples.

### *-tools
Scripts to automate Hyper-V/Windows Container things.

>>>>>>> TP3
15 changes: 15 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# TODO

This file lists the things we'd like to get done. Some of it is stuff we're working on and some of it is stuff anyone in the community could help with.

## Minor Fixes
* Spelling, grammar, review
* Containers Work in Progress and Known Issues pages
* Add exact error messages for more searchable resoultion to issues.

## Articles to edit/revise
* Hyper-V on Windows [remote host management article](./doc-site/virtualization/hyperv_on_windows/user_guide/remote_host_management.md)

## Articles to add
* README for all Container samples and tools
* README for all Hyper-V samples and tools
Loading

0 comments on commit 7818303

Please sign in to comment.