Skip to content

Commit

Permalink
renamed repo/fixed headings (#1186)
Browse files Browse the repository at this point in the history
  • Loading branch information
mairaw authored and BillWagner committed Oct 29, 2016
1 parent 0b3e6e5 commit 15c55a8
Show file tree
Hide file tree
Showing 62 changed files with 141 additions and 158 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Contributing
============
# Contributing

Thank you for your interest in contributing to the .NET documentation!

Expand Down Expand Up @@ -54,7 +53,7 @@ Also, remove the "wrench" icon (🔧) from the TOC and the file heading, if appl
/porting
porting_sample.cs

**Step 5:** Submit a Pull Request (PR) from your branch to `dotnet/core-docs/master`.
**Step 5:** Submit a Pull Request (PR) from your branch to `dotnet/docs/master`.

If your PR is addressing an existing issue, add the `Fixes #Issue_Number` keyword to the commit message or PR description, so the issue can be automatically closed when the PR is merged. For more information, see [Closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/).

Expand All @@ -77,7 +76,7 @@ Below is a short list of guiding rules that you should keep in mind when you are
- **DO** follow the [GitHub Flow workflow](https://guides.github.com/introduction/flow/).
- **DO** blog and tweet (or whatever) about your contributions, frequently!

> Note: you might notice that some of the topics are not currently following all the guidelines specified here and on the [style guide](./styleguide/template.md) as well. We're working towards achieving consistency throughout the site. Check the list of [open issues](https://github.com/dotnet/core-docs/issues?q=is%3Aissue+is%3Aopen+label%3Aguidelines-adherence) we're currently tracking for that specific goal.
> Note: you might notice that some of the topics are not currently following all the guidelines specified here and on the [style guide](./styleguide/template.md) as well. We're working towards achieving consistency throughout the site. Check the list of [open issues](https://github.com/dotnet/docs/issues?q=is%3Aissue+is%3Aopen+label%3Aguidelines-adherence) we're currently tracking for that specific goal.
## Building the docs

Expand Down Expand Up @@ -139,4 +138,4 @@ with `http://docs.microsoft.com/dotnet/articles`.

Your topic will also contain links to the sample. Link directly to the sample's folder on GitHub.

For more information, see the [Samples Readme](https://github.com/dotnet/core-docs/blob/master/samples/README.md).
For more information, see the [Samples Readme](https://github.com/dotnet/docs/blob/master/samples/README.md).
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.NET Core Documentation
=======================
#.NET Core Documentation

This repo contains work-in-progress documentation for .NET Core. To contribute, see the [Contributing Guide](CONTRIBUTING.md) and the [issues list](https://github.com/dotnet/core-docs/issues).
This repo contains work-in-progress documentation for .NET Core. To contribute, see the [Contributing Guide](CONTRIBUTING.md) and the [issues list](https://github.com/dotnet/docs/issues).

We welcome contributions to help us improve and complete the .NET Core docs. Feel free to copy/paste documentation from [.NET Framework docs](https://msdn.microsoft.com/library/w0x726c2.aspx) as a starting point for .NET Core docs. We hope to port higher-quality .NET Core content to the .NET Framework docs, so investments in this repo will benefit all .NET users. We anticipate that [Xamarin](http://developer.xamarin.com/api/root/classlib/), [Mono](http://docs.go-mono.com/?link=root%3a%2fclasslib) and [Unity](http://docs.unity3d.com/Manual/index.html) will also use this documentation.

Expand Down
2 changes: 1 addition & 1 deletion api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -597,4 +597,4 @@ The following is a list of namespaces in the .NET Core class library. Each names

## Improving the Documentation ##

If you find an issue or an inconsistency, we would love to hear about it! Go to the [.NET Core docs repo](https://github.com/dotnet/core-docs/ ".NET Core docs repo") on Github, and open an issue to let us know.
If you find an issue or an inconsistency, we would love to hear about it! Go to the [.NET Core docs repo](https://github.com/dotnet/docs/ ".NET Core docs repo") on Github, and open an issue to let us know.
2 changes: 1 addition & 1 deletion ci-scripts/provisionvm.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ LogWrite "Will execute this:"
$executedCommand = "$java $jar $destSource $jnlpCredentialsFlag $credentials $jnlpUrl $serverURL }"
LogWrite $executedCommand

Invoke-WebRequest "https://raw.githubusercontent.com/dotnet/core-docs/master/ci-scripts/agentman.ps1" -OutFile "$ProvisionArtifacts\agentman.ps1"
Invoke-WebRequest "https://raw.githubusercontent.com/dotnet/docs/master/ci-scripts/agentman.ps1" -OutFile "$ProvisionArtifacts\agentman.ps1"
$executedCommand | Out-File -Encoding "UTF8" $ProvisionArtifacts\agentman.ps1 -append

# SchTasks /Create /SC MINUTE /MO 1 /TN "Jenkins Agent Inspector" /TR "powershell.exe -File $ProvisionArtifacts\agentman.ps1 -WindowStyle Hidden"
Expand Down
18 changes: 6 additions & 12 deletions docs/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ ms.devlang: dotnet
ms.assetid: 2e38e9d9-8284-46ee-a15f-199adc4f26f4
---

About .NET
==========
# About .NET

> Check out the ["Getting Started with .NET Core" tutorials](../core/getting-started.md) to learn how to create a simple .NET Core application. It only takes a few minutes to get your first app up and running.
Expand All @@ -31,17 +30,15 @@ Multiple [.NET implementations and products](products.md) are available, based o
- Browse the [.NET API Library](../../api/index.md)
- [Introduction to the Common Language Runtime](https://github.com/dotnet/coreclr/blob/master/Documentation/botr/intro-to-clr.md)

Fundamentals
------------
## Fundamentals

**Multi-Language** -- .NET provides a well-defined type system, file formats, runtime, framework and tools that can be used by multiple languages, both for their own execution and also to interoperate with other languages using those same components of .NET as their shared currency.

**Managed Memory** -- .NET automatically manages memory for you via a garbage collector. It ensures that you always reference live objects, guaranteeing that you avoid nasty problems like buffer overruns and access violations. This includes array bounds checking.

**Type Safety** -- The primary .NET model for functionality and memory representation is "types". Types define shape and optionally behavior. The runtime ensures that calling code can only operate on types according to their definition and specified visibility of members, providing consistent, reliable and secure results.

Features
--------
## Features

**User-defined Value Types** -- Value types are a useful category of types since they offer the semantic of "pass by value" instead of "pass by reference", as is the case for classes. Value types are most obviously usefully for numeric data. .NET enables value types for both primitive types, like integers, and user-defined types.

Expand All @@ -53,15 +50,13 @@ Features

**Cross-platform** -- .NET was intended to be cross platform from its inception. The binary format and the instruction set are operating system, CPU and pointer-size agnostic. A given .NET binary built in 2000 to run on a 32-bit Windows machine can run on the ARM64 iOS device on 2016 without modification.

Open source
-----------
## Open source

The [.NET Core](https://github.com/dotnet/core) and [Mono](https://github.com/mono/mono) implementations of .NET are open source, using the MIT license. Documentation uses the [Creative Commons CC-BY](https://creativecommons.org/licenses/by/4.0/) license. .NET Core and Mono are sponsored by Microsoft and have many contributors from the community.

These general purpose runtimes can be used as the basis of academic research or teaching/learning or commercial products. Their open nature also means that anyone can contribute back to the upstream product code given a bug or the desire for a new feature.

Projects
--------
## Projects

- [CoreCLR](https://github.com/dotnet/coreclr) - .NET runtime, used by .NET Core.
- [Mono](https://github.com/mono/mono) - .NET runtime, used by Xamarin and others.
Expand All @@ -70,8 +65,7 @@ Projects
- [F#](https://github.com/microsoft/visualfsharp) - F# compiler.
- [Xamarin SDK](http://open.xamarin.com) - Tools and libraries needed to write Android, iOS and macOS in C# and F#.

Standardized
------------
## Standardized

.NET is specified via open [ECMA standards](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/dotnet-standards.md) that outline its capabilities and that can be used to make a new implementation. There are other .NET implementations, with Mono and Unity being the most popular beyond the Microsoft ones.

11 changes: 4 additions & 7 deletions docs/about/products.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ ms.devlang: dotnet
ms.assetid: 2e38e9d9-8284-46ee-a15f-199adc4f26f4
---

.NET Products
=============
# .NET Products

.NET is a very flexible, general purpose and inherently cross-platform [specification](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/dotnet-standards.md) for building developer products. It is used for all of the most popular app categories: desktop, mobile, cloud, gaming and IoT.

Expand All @@ -22,8 +21,7 @@ There are two subtly different terms used in this document:
- ".NET product" - Enables you to build an app for one or more target platforms.
- ".NET implementation" - Some combination of a runtime, framework and tools that can execute ".NET code" on which products are based.

Product Categories
------------------
## Product Categories

.NET products are available for each of the following product categories.

Expand Down Expand Up @@ -66,8 +64,7 @@ You can build Web and Cloud apps for Windows and Linux.
- [ASP.NET](http://www.asp.net/) for Windows with the [.NET Framework](#net-framework)
- [ASP.NET Core](http://docs.asp.net/) for Windows, macOS and Linux with [.NET Core](#net-core)

.NET Implementations
--------------------
## .NET Implementations

Major commercial and open source .NET implementations are listed below, in alphabetical order.

Expand All @@ -83,7 +80,7 @@ The following are the main characteristics of .NET Core:

**Cross-platform** - .NET Core supports three operating systems families: Linux, Windows and macOS. .NET Core apps are cross-platform by default. You can write apps and libraries that run unmodified across supported OSes.

**Open Source** - [.NET Core](https://github.com/dotnet/core) is available on GitHub, licensed with the [MIT](https://github.com/dotnet/coreclr/blob/master/LICENSE.TXT) and [Apache 2](https://github.com/dotnet/roslyn/blob/master/License.txt) licenses (licensing is per component). Documentation is [CC-BY](https://github.com/dotnet/core-docs/blob/master/license.txt). .NET Core also makes use of a significant set of open source industry dependencies, listed in the [.NET Core release notes](https://github.com/dotnet/core/releases).
**Open Source** - [.NET Core](https://github.com/dotnet/core) is available on GitHub, licensed with the [MIT](https://github.com/dotnet/coreclr/blob/master/LICENSE.TXT) and [Apache 2](https://github.com/dotnet/roslyn/blob/master/License.txt) licenses (licensing is per component). Documentation is [CC-BY](https://github.com/dotnet/docs/blob/master/license.txt). .NET Core also makes use of a significant set of open source industry dependencies, listed in the [.NET Core release notes](https://github.com/dotnet/core/releases).

**Natural acquisition** - NET Core is distributed in several forms, aligning with specific developer needs. You can acquire .NET Core with the [.NET Core SDK](https://dot.net/core) installer (or zips) or via OS-specific package managers, such as APT and Yum. [Official .NET Core Docker images](https://hub.docker.com/r/microsoft/dotnet/) are available on Docker Hub. Higher-level framework libraries and the larger .NET library ecosystem are available on [NuGet](http://www.nuget.org/).

Expand Down
4 changes: 2 additions & 2 deletions docs/core/app-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ ms.prod: .net-core
ms.technology: .net-core-technologies
ms.devlang: dotnet
ms.assetid: 93488a0b-c94c-4ed6-97ea-571bb23a862e
redirect_url: /deploying/index
---

.NET Core App Types
===================
# .NET Core App Types

## Content moved!
This content has merged and moved to the [.NET Core Application Deployment](deploying/index.md) topic.
2 changes: 1 addition & 1 deletion docs/core/deploying/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ ms.assetid: 1db00fb1-d947-480d-8d7d-7152e67b0585
> We welcome your input to help shape the scope and approach.
>
> Learn more about how you can contribute on
> [GitHub](https://github.com/dotnet/core-docs/blob/master/CONTRIBUTING.md).
> [GitHub](https://github.com/dotnet/docs/blob/master/CONTRIBUTING.md).
>
2 changes: 1 addition & 1 deletion docs/core/porting/nuget-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ms.assetid: 4d823e71-19ac-4419-953e-b47aa58f5538
> We welcome your input to help shape the scope and approach.
>
> Learn more about how you can contribute on
> [GitHub](https://github.com/dotnet/core-docs/blob/master/CONTRIBUTING.md).
> [GitHub](https://github.com/dotnet/docs/blob/master/CONTRIBUTING.md).
>

12 changes: 6 additions & 6 deletions docs/core/porting/project-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,18 +100,18 @@ Please see [.NET Core porting documentation][porting-doc] for more guidance on m

[porting-doc]: index.md
[example-initial-project]: media/project-structure/project.png "Existing project"
[example-initial-project-code]: https://github.com/dotnet/core-docs/tree/master/samples/framework/libraries/migrate-library/
[example-initial-project-code]: https://github.com/dotnet/docs/tree/master/samples/framework/libraries/migrate-library/

[example-xproj]: media/project-structure/project.xproj.png "Create an xproj that targets multiple frameworks"
[example-xproj-code]: https://github.com/dotnet/core-docs/tree/master/samples/framework/libraries/migrate-library-xproj/
[example-xproj-projectjson]: https://github.com/dotnet/core-docs/tree/master/samples/framework/libraries/migrate-library-xproj/src/Car/project.json
[example-xproj-projectjson-test]: https://github.com/dotnet/core-docs/tree/master/samples/framework/libraries/migrate-library-xproj/tests/Car.Tests/project.json
[example-xproj-code]: https://github.com/dotnet/docs/tree/master/samples/framework/libraries/migrate-library-xproj/
[example-xproj-projectjson]: https://github.com/dotnet/docs/tree/master/samples/framework/libraries/migrate-library-xproj/src/Car/project.json
[example-xproj-projectjson-test]: https://github.com/dotnet/docs/tree/master/samples/framework/libraries/migrate-library-xproj/tests/Car.Tests/project.json

[example-xproj-different-folder]: media/project-structure/project.xproj.different.png ".NET Core project with existing PCL in different folder"
[example-xproj-different-code]: https://github.com/dotnet/core-docs/tree/master/samples/framework/libraries/migrate-library-xproj-keep-csproj/
[example-xproj-different-code]: https://github.com/dotnet/docs/tree/master/samples/framework/libraries/migrate-library-xproj-keep-csproj/

[example-pcl]: media/project-structure/project.pcl.png "PCL Targeting .NET Core"
[example-pcl-code]: https://github.com/dotnet/core-docs/tree/master/samples/framework/libraries/migrate-library-pcl
[example-pcl-code]: https://github.com/dotnet/docs/tree/master/samples/framework/libraries/migrate-library-pcl

[option-xproj]: #replace-existing-projects-with-a-multi-targeted-net-core-project-xproj
[option-pcl]: #create-a-portable-class-library-pcl-to-target-net-core
Expand Down
8 changes: 4 additions & 4 deletions docs/core/testing/unit-testing-with-dotnet-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ms.assetid: bdcdb812-6f13-4f20-9e90-0c0977937142

By [Steve Smith](http://ardalis.com) and [Bill Wagner](https://github.com/BillWagner)

[View or download sample code](https://github.com/dotnet/core-docs/tree/master/samples/core/getting-started/unit-testing-using-dotnet-test)
[View or download sample code](https://github.com/dotnet/docs/tree/master/samples/core/getting-started/unit-testing-using-dotnet-test)

## Creating the Projects

Expand Down Expand Up @@ -138,7 +138,7 @@ not in the NuGet feed. Without this key, you might download
a package with the same name as your internal library.

You can see the entire file in the
[samples repository](https://github.com/dotnet/core-docs/blob/master/samples/core/getting-started/unit-testing-using-dotnet-test/test/PrimeService.Tests/project.json)
[samples repository](https://github.com/dotnet/docs/blob/master/samples/core/getting-started/unit-testing-using-dotnet-test/test/PrimeService.Tests/project.json)
on GitHub.

After this initial structure is in place, you can write your first test.
Expand Down Expand Up @@ -242,9 +242,9 @@ Now, these tests all pass.
You continue to iterate by adding more tests, more theories,
and more code in the main library. You'll quickly end up
with the
[finished version of the tests](https://github.com/dotnet/core-docs/blob/master/samples/core/getting-started/unit-testing-using-dotnet-test/test/PrimeService.Tests/PrimeServie_IsPrimeShould.cs)
[finished version of the tests](https://github.com/dotnet/docs/blob/master/samples/core/getting-started/unit-testing-using-dotnet-test/test/PrimeService.Tests/PrimeServie_IsPrimeShould.cs)
and the
[complete implementation of the library](https://github.com/dotnet/core-docs/blob/master/samples/core/getting-started/unit-testing-using-dotnet-test/src/PrimeService/PrimeService.cs).
[complete implementation of the library](https://github.com/dotnet/docs/blob/master/samples/core/getting-started/unit-testing-using-dotnet-test/src/PrimeService/PrimeService.cs).
You've built a small library and a set of unit tests for that library.
You've structured this solution so that adding new packages and tests
Expand Down
4 changes: 2 additions & 2 deletions docs/core/tools/using-ci-with-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Just use:
dotnet: 1.0.0-preview2-003121
```
Travis can run both `osx` (OS X 10.11) and `linux` ( Ubuntu 14.04 ) job in a build matrix, see [example .travis.yml](https://github.com/dotnet/core-docs/blob/master/.travis.yml)
Travis can run both `osx` (OS X 10.11) and `linux` ( Ubuntu 14.04 ) job in a build matrix, see [example .travis.yml](https://github.com/dotnet/docs/blob/master/.travis.yml)
for more information.

### AppVeyor
Expand All @@ -87,7 +87,7 @@ Just use:
os: Visual Studio 2015
```

It's possible to install a specific version of .NET Core SDK, see [example appveyor.yml](https://github.com/dotnet/core-docs/blob/master/appveyor.yml)
It's possible to install a specific version of .NET Core SDK, see [example appveyor.yml](https://github.com/dotnet/docs/blob/master/appveyor.yml)
for more info.

In the example, the .NET Core SDK binaries are downloaded, unzipped in a subdirectory and added to `PATH` env var.
Expand Down
4 changes: 2 additions & 2 deletions docs/core/tutorials/cli-console-app-tutorial-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ ms.assetid: dab9e2f9-9088-4089-b990-fbc3d8dcd611
>
> We welcome your input to help shape the scope and approach. You can
> track the status and provide input on this
> [issue](https://github.com/dotnet/core-docs/issues/180) at GitHub.
> [issue](https://github.com/dotnet/docs/issues/180) at GitHub.
>
> If you would like to review early drafts and outlines of this
> topic, please leave a note with your contact information in the issue.
>
> Learn more about how you can contribute on
> [GitHub](https://github.com/dotnet/core-docs/blob/master/CONTRIBUTING.md).
> [GitHub](https://github.com/dotnet/docs/blob/master/CONTRIBUTING.md).
>
3 changes: 1 addition & 2 deletions docs/core/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ ms.devlang: dotnet
ms.assetid: f6f654b1-1d2c-4105-8376-7c1959e23803
---

.NET Core Tutorials
===================
# .NET Core Tutorials

The following tutorials are available for learning about .NET Core.

Expand Down
2 changes: 1 addition & 1 deletion docs/core/tutorials/libraries-with-vs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ ms.assetid: 01b988ed-583f-48c8-a016-caeee282e0a6
> We welcome your input to help shape the scope and approach.
>
> Learn more about how you can contribute on
> [GitHub](https://github.com/dotnet/core-docs/blob/master/CONTRIBUTING.md).
> [GitHub](https://github.com/dotnet/docs/blob/master/CONTRIBUTING.md).
>
2 changes: 1 addition & 1 deletion docs/core/tutorials/using-on-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ You can find the links to all of these at the [.NET home page](http://dot.net).
## Getting Started

The source for this tutorial is available on
[GitHub](https://github.com/dotnet/core-docs/tree/master/samples/core/getting-started/golden).
[GitHub](https://github.com/dotnet/docs/tree/master/samples/core/getting-started/golden).

Start Visual Studio Code. Press Ctrl + '\`' (the back-quote character) to open
an embedded terminal in VS Code. (Alternatively, you can use a separate
Expand Down
Loading

0 comments on commit 15c55a8

Please sign in to comment.