Skip to content

Commit

Permalink
Sync (#1)
Browse files Browse the repository at this point in the history
* Basic types, classes and structs (dotnet#1134)

* Basic types, classes and structs

Split Types topic and added C# 7 literala features

* Fixed snippet links

* Fixed two more links

* Addressed all review comments

* Removed wrenches again

after esolving conflict

* simplify getting IP address (dotnet#1107)

* Grammar error (dotnet#1145)

I suppose that "to compile and the code" is wrong, it should be "to compile the code"

* Don't rely on `docker exec` for getting ip address (dotnet#1108)

* Update index.md (dotnet#1146)

* adding some new links (dotnet#1139)

* Patch 1 (dotnet#1147)

* Update generating-fsharp-types-from-edmx.md

Removed erroneous ) from the select statement in the example demonstrating a where clause

* Update generating-fsharp-types-from-edmx.md

Correcting the join statement in the example for joining two tables

* Update generating-fsharp-types-from-edmx.md

Under the section "Creating an EDMX file," adding the link to the "Configuring the Entity Data Model" section.

* Update generating-fsharp-types-from-edmx.md

Correcting indentation for the changeHireDate function

* Fix title and metadata (dotnet#1149)

* Reviewed the CLI topic (dotnet#1124)

* Reviewed the CLI topic

* added version

* undoing a small change

* Fix missing link

Fix missing link for raw markdown template.

* 🔧 small fixes (dotnet#1153)

* Updates to the CLI commands reference (dotnet#1129)

* reviewed cli commands topics

* removed byline

* minor fixes

* fixed broken links

* addressed feedback

* clarified language

* fixed typo

* Feature/fsharp app service (dotnet#1156)

* Add F# App Service API example

* Add Hosting F# in a web application on Azure link

* Update native dependencies section to specify RID correctly (dotnet#1144)

* Update native dependencies section to specify RID correctly

* Address feedback

* Address @mairaw feedback I missed

* adding new video (dotnet#1154)

* Adding images for getting started VS Code doc

* Fix <- in markdown (dotnet#1159)

* Corrected typo

* Added F# with Mobius for Spark on Azure (dotnet#1161)

* Wrong place for image

* Wrong place for image

* Wrong place for image

* Wrong place for image

* fix broken link (dotnet#1166)

* fix broken link

* fixed another broken link

* Fix Binary Search Tree insert function (dotnet#1167)

* remove redundant "*" (dotnet#1168)

* Update portability-analyzer.md (dotnet#1155)

* Update portability-analyzer.md

Made some improvements to the topic

* updates

* Update index.md (dotnet#1163)

* Update index.md

Fix links for dotnet-apiport.

* Update index.md

* adding macOS Sierra support (dotnet#1164)

* adding sierra support

* added missing word

* Hello World with Visual Studio 2015

* Fix extension docs (dotnet#1178)

See dotnet/fsharp#1670

* excluding tokens from ops validation (dotnet#1182)

* renamed repo/fixed headings (dotnet#1186)

* Corrected publishing warnings (dotnet#1189)

* Corrected publishing warnings

* Fixed two more broken links.

* fixed broken link

* Update README.md

* Remove pointer to github.com/microsoft/docs/readme.md (dotnet#1191)

* updated netstandard version (dotnet#1169)

* fixed repo name (dotnet#1193)

* added missing H1 (dotnet#1192)

* Update toc.md

* Updating languages used in sample article (dotnet#1199)

* Methods topic ported from MSDN and revised.

* Incorporated comments.

* Corrected publishing errors

* Added changes lost during merge.

* Update toc.md

* fixed broken anchors (dotnet#1194)

* fixed broken anchors
* fixed more links

* fixed more links

* fixed links

* fixed more links

* fixed casing

* more fixes

* more fixes

* Update index.md

* reverting to previous index structure.

* fix broken-links for app-types document (dotnet#1203)

* fix broken-links for app-types document

Responding to a user comment on
https://docs.microsoft.com/en-us/dotnet/articles/core/tutorials/using-wi
th-xplat-cli

* fix edit paste error of .md.md

* fixing links again

The index.md cannot be part of the url. The build removes ‘.md’, but
keeps ‘index’. That fails.

* fix typo in links

* Propose VS Code Getting Started

Getting started page for .NET Core, C# extension, and VS Code.

* Deleted "Next Steps" Section

Let's assume the surrounding documentation on the .NET Docs is where users will want to browse next.

* Deleted Wrench, Added VS Code Install Step

* Deleted "blazing" and "fun"

* Add images

* Fixed Pic links

* Fixed old commits

* fixing typo (dotnet#1202)

* Update global-json.md (dotnet#996)

* Update global-json.md

* removing unkown properties

* updated topic

* Two edits, and modified TOC

* Config tweak for PDF.

* Change the format

* respond to remaining feedback on 1077

Also, update the date and add the ms.author metadata.

indent sample to preserve one list

I’ll examine the build output on staging and then squash.

* Update expressions.md

Update expressions.md

* Respond to feedback on PR dotnet#1076

Also, updated the publish date, and add ms.author metadata.

* Formatting for the config.

* Fix formatting console-teleprompter.md

Update console-teleprompter.md

Update console-teleprompter.md

Update console-teleprompter.md

* respond to remaining feedback on PR dotnet#1073

Also, updated the freshness date, and add the ms.author metadata tag.

Respond to updated feedback

Respond to @rpetrusha feedback.

Fix a few broken links

* clean up first sentence (dotnet#1214)

* Recommend snippet syntax (dotnet#1209)

* update template to recommend code snippets

We prefer them to inline code that doesn’t run through the CI build.

* Fix contributing link

* update list of languages to the correct smaller set.

* respond to feedback

* respond to feedback.

* Add link to and sample code application to post (dotnet#1215)

* add link to and sample code application to post

* remove unneeded files

* Kick off live build again.

* create initial contributing.md for fast releases. (dotnet#1206)

* create initial contributing.md for fast releases.

* fix markdown syntax issue.

* fix the link to the main docs folder.

* one more time, fixing the link.

* add note about contributing.md location.

* Add any contributing.md files to the exclude list

We don’t want them on the live site.

* stashing to switch branches.

* update the link in the warning include.

* update with correct current release terms.

* Update for feedback.

* new hub page design (dotnet#1220)

* new hub page design

* adding svg extension

* 🐤 Config change.

* fix typo (dotnet#1217)

* November changes (dotnet#1157)

* Updates for november release

* Add getting-started to About .NET

* Change links

* Update to Platform as the name

* fix links

* Fix links in tour

* Fix link

* Update names

* Update Framework Name

* Remove About and replace with .NET Platform Guide

* Fixes

* Change .NET Framework to .NET Framework on Docker

* Remove about article and make it the index

* Update title in index file

* Updates

* Updates

* fix link

* fix link

* fix link

* Redirects don't support folder renames

* fix links

* Move files

* feedback

* fix link

* Undo GUID change

* Updates

* fix broken link (dotnet#1222)

* Adding MASTER to PDF build.

* Hubpage (dotnet#1227)

* testing image location

* changing image links

* fix more image links

* Update attributed.md: Pre -> Previous (dotnet#1224)

The button text only shows "Pre", which is different from the "Previous" button in other articles in this section.

* Add git to prerequisites for getting started with F# on vscode article (dotnet#1180)

* Add git to prerequisites

* Update getting-started-vscode.md

* Update getting-started-vscode.md

* fixing some links (dotnet#1228)

* Fix heading in F# vscode article (dotnet#1229)

Was missing 'with'.

* New in csharp7 (dotnet#1188)

* Create What's new in C# 7 content

* fix a merge mistake.

* update per editorial feedback.

* Fixing OPS build

* address review comments.

From @jaredpar

* updates for the hub page

* VS page conflict fix

* testing hover image link

* fixing link

* updating Hub image urls

* changed links

* trying to fix build warnings

* Spelling error (dotnet#1234)

* 📚 migration changes (dotnet#1235)

* migration files

* checkin changes

* more fixes

* last fixes

* fixed broken links

* ran link fix tool again

* Removed Wrench -- Issue dotnet#1213

* Removed wrench -- issue dotnet#1213

* Removed wrench -- Issue dotnet#1213

* The C# MicroServices tutorial left out an install of node.js's npm manager; added link to node.js. (dotnet#1219)

* Updated the tutorial to help any user who is not coming from a javascript background who may not have npm installed; provided link to npm for their download

* Grammar changes

* Moved the instruction to install npm into its own paragraph and changed the logical structure of the instructions to follow.

* Removed to be installed

* fixing broken link (dotnet#1223)

* fixing broken link

* Update warning.md

* Update index.md (dotnet#1151)

add link to simple introduction to creating an azure function in f# on azure

* updated featured png fallbacks, hiding breadcrumb (dotnet#1238)

* updated featured png fallbacks, hiding breadcrumb

* updated panel images

* remove dead wood and market speak (dotnet#1183)

* remove dead wood and market speak

see https://msdnstage.redmond.corp.microsoft.com/en-us/ce-csi-docs/contributors-guide-internal/style-and-voice?branch=master

For such a high visibility topic can't we run it by an editor?

* removed Core

* adding new CLI nuget commands (dotnet#1218)

* adding new CLI nuget commands

* small change

* addressed feedback

* last updates and renamed folder

* Update CLI golden path tutorial for Preview 3.

* macOS images (dotnet#1240)

* Remove Syntax Reference and point to Language Reference (dotnet#1225)

* Finish CLI golden path.

* Fix missed project.json occurrences.

* Move new preview3 docs under the cli-preview3 folder.

* Add .NET Components article (dotnet#1232)

* Add .NET Components article

* Add to TOC and metadata fixes

* Fix error in paragraph

* More fixed

* Reword awkward targeting sentence

* Fix links

* Better picture

* Feedback

* .NET Architectural components as the name name

* Add .NET Platform getting started (dotnet#1241)

* Add .NET Platform getting started

* feedback

* Feedback

* Update hub page to have correct name and link for components (dotnet#1245)

* Add Core vs Framework for server apps article (dotnet#1239)

* Add Core vs Framework for server apps article

* Feedback

* Feedback

* Feedback

* Revised Tour of .NET (dotnet#1236)

* First changes

* Finish up draft of revised tour

* Fix links

* Fix links

* Fix note

* Feedback

* Feedback

* Feedback

* Fix bad link

* redirecting old topics (dotnet#1246)

* readded files to proper redirect them

* added missing toc entry

* fixed redirect url

* Update toc.md

Removed top-level wrenches.

* Initial draft of Hello World app.

* Checkin for class library tutorial.

* Consuming a class library check-in

* Updated for final RC build (dotnet#2)

* Updated for final RC build

Updated screenshots, addressed accessibility, other minor changes

* Updated library topics

* Revised publishing topic, plus corrected typo

* Corrected bad verb tense.

* Addressed comment, added context and additional explanation, corrected title omission

* Addressed additional comments

* fix one build error.

* fix the link URL for a code snippet

* Update toc.md

Updated TOC for new VS 2015 content, removed VS Code wrench and corrected title.

* fixing TOC issue

* Corrected bad links in VS 2017 RC topics.

* Corrected title of library topic in TOC

* top-level getting started portal page

* Fix broken connect links (dotnet#1250)

* fix a bad link

* fix broken links

these came in 3 cases.
1. Some links used ... instead of .. to navigate up a folder.
2. Some links were off by one directory up in navigation.
3. Some links used back-slash instead of slash.
4. Typos.

1 and 2 might be significant if we run the migration script again.

* rename getting started with libraries and fix links

The name had an '_ ' and should have '-' instead

* fix build warnings

* wrong API name:  IsUpperCase -> IsUpper

* Update hub links to actual content (dotnet#1251)

* Update links to actual content

* Add '/'

* Corrected errors, added library topic, fixed typo in another topic

* CLI Preview 3 docs (dotnet#1233)

Add CLI Preview 3 documentation

This will add Preview 3 CLI documentation in a separate folder under docs/core/preview3. The CLI Preview 3 bits 
are the first released bits to contain the MSbuild support and have no support for working with project.json projects. 

Changes done:

* Modified the extensiblity document to add extending the tools via targets in NuGet packages
* Added dependency management documetn that explains how to do package management manually in the new csproj format
* Added csproj reference guide (NOTE: this needs completing)
* Added dotnet-migrate command docs
* Fixed all of the other command references to be correct as to Preview 3 bits

* Add VS 2017 getting started topics.

* Cleanup links and reconcile folder structure with other PRs.

* Add TOC.

* Updated warning (dotnet#1256)

* Update warning.md

* Update warning.md

* fixed toc

* fixing GH alias (dotnet#1260)

* fixing GH alias 

/cc @bleroy

I'm adding myself as the ms.author so I get the incoming feedback and so forth. let me know if you disagree with that.

* fixing broken link

* fixing toc links

* fixed links and some typos (dotnet#1259)

* fixed links and some typos
* more fixes

* Remove about .NET article (dotnet#1249)

* Fix preview 3 download link.

* Fixed merge conflict (dotnet#1265)

Also fixed couple of typos.

* Fix typo (dotnet#1267)

* Update index.md (dotnet#1271)

* Update index.md

* Removing extra a

* fixing broken links (dotnet#1263)

* fixing broken links

* more fixes

* adding missing extension

* Fixed links to preview 2 CLI code (dotnet#1274)

* Fixed included notes (dotnet#1275)

* Remove extraneous brackets

* Fixes miscellaneous issues in VB content (dotnet#1268)

Fixed broken links, removed invalid links, etc.

* Preview 3 edits (dotnet#1273)

* Preview 3 edits

* Added migrate to the list of commands
* Used docfx syntax for notes
* Fixed heading levels in new articles
* Made pseudo-variables in csproj consistent in dependencies
* Remove references to project.json sections from deploying
* Remove F# from dotnet new, since it's not supported
* Added back missing --framework to dotnet test
* Typos, grammar and other small fixes

* Removed unnecessary Overview headings

* fixed TOC (dotnet#1280)

* fixed TOC

* removed wrench

* Fixing broken links (dotnet#1276)

* Fixing broken links

* Attempted to fix cross reference warning

* Link to docs.ms instead of MSDN

Also simplified relative paths

* Absolute urls and other fixes (dotnet#1281)

* absolute urls and other link fixes

* fixed broken link

* fixed issues causing formatting problems

* removed extra parentheses

* fixed broken link

* fixed xref warnings

* Added links to Visual Studio 2017 topics (dotnet#1282)

* Revisions to lambda expressions topic.

* Small syntax fixes

YOu'll => You'll
IgnoreDatamember => IgnoreDataMember

* Fixed bad code snippet tags.

* Minor TOC improvements

* Addressed comments from @shoag

* Additional revisions from Bill and Maira.

* Create detailed article on C# tuples (dotnet#1284)

* Create Tuples content in C# 7 content
Outline and start on first draft.

* finish tuples article and samples

Ready for a final proofread

* proofread, remove wrenches

This is now ready for review.

* respond to all feedback.

Reviews from @svick and @rpetrusha

* fixed typo (dotnet#1296)

* clarify wording of "Functions as First-Class Values" (dotnet#1290)

* custom operators using `?` (dotnet#1291)

added an additional rule for custom operators from the F# 4.0 Spec Section 3.7

* added missing links (dotnet#1295)

* added missing links

* changed links to absolutely links

Thanks @mairaw

* fixed api links

* update input file names for case sensitive file systems (dotnet#1299)

Fixing a customer reported issue.

* remove 'wrench' articles that have been ported (dotnet#1298)

* remove 'wrench' articles that have been ported

Several not-yet-written articles have been covered by the port of the
C# content from MSDN.  These still need to be reviewed and updated, but
they are all now present.

* configure redirects for deprecated articles.

* don't include the file extension on redirects.

* update the path for redirection

* find and replace links to content that moved.

* Add documented example of using a webjob in f# (dotnet#1289)

* f# webjob doc and example

* fix grammar

* added new line

* Updating WebApiClient (dotnet#1304)

Adding missing `using` statements

* Small fixes (dotnet#1303)

* Added keywords metadata field.

* added default values for api ref metadata (dotnet#1300)

* added default values for api ref metadata

* fixing path

* changing to an alias

* Adding Search Scope

* Update docfx.json to add search scope

* removing broken links (dotnet#1312)

* Text, images, code for inheritance tutorial

* Fixed bad code reference

* Corrected another bad code snippet tag.

* Metadata updates (dotnet#1313)

* first round of metadata updates

* secound round of updates

* small update

* Update debugging-with-visual-studio-2017.md

Corrected spelling...

* Add Debug section to VS Code Getting Started (dotnet#1314)

* Add Debug instructions

* Additional changes to inheritance in programming guide.

* Fix broken sentence in discriminated-unions.md (dotnet#1322)

* Updated LINQ topics for C# Concepts section (dotnet#1302)

* Updated LINQ topics for C# Concepts section

Phase one - additional topics will be moved from the Programming Guide
later

* Fixed build errors

* Addressed feedback

* Created a LINQ folder and moved the files; updated links

* Updated TOC with new path

* Updated redirect URLs

* Fixed one more redirect

* Use S110 build tool version for building (dotnet#1328)

* Use 1.22.3 packages and plugin

* Update .openpublishing.publish.config.json

* Revisions to inheritance topic.

* Addressed additional comments

* turning off build comments on PRs (dotnet#1327)

/cc @BillWagner

* fixing tip (dotnet#1320)

* fixed tip style

* test

* readded tip

* content review

* added missing changes

* few more fixes

* rezising asset image

* addressed feedback

* Fixed broken links to LINQ topic (dotnet#1331)

* Fixed broken links to LINQ topic

* fixed merge issues

* Update .openpublishing.publish.config.json

* rid-catalog.md: Add rhel.7-x64 rid (dotnet#1324)

* make readable (dotnet#1325)

* make readable

* rpetrusha feedback

* typo

* Final corrections, corrected code snippet tag.

* Updated TOC to add inheritance topic.

* Changed wrong installation path in documentation. (dotnet#1323)

* Corrected lowercase 'i'

* Updated hub page images from Design (dotnet#1337)

* dotnet#275 string interpolation tutorial for C# (dotnet#1317)

* dotnet#275 string interpolation tutorial for C#

* dotnet#275 move code examples into snippets so they can be run by DocFx

* dotnet#275 corrects and fixes of string interpolation tutorial per review from BillWagner

* dotnet#275 forgot namespace for CultureInfo

* dotnet#275 typo fix

* dotnet#275 remove intro header per recommendation

* update metadata and TOC for tutorial (dotnet#1340)

* update metadata and TOC for tutorial

Also, add a reference to the inheritance tutorial (which was missing at
the time)

* Update string-interpolation.md

* Removed incorrect semocolons from operators (dotnet#1338)

* Fix code without right space. (dotnet#1342)

Fix code without right space.

* Add missing parenthesis (dotnet#1344)

* Update how-to-define-value-equality-for-a-type.md

spelling error

* Update how-to-define-value-equality-for-a-type.md (dotnet#1349)

public and non-public fields is the same thing as fields

e.g.,  x || !x == true

* corrected typo (dotnet#1352)

* fixing warning message (dotnet#1353)

* fixing warning message

* re-added part of the sample

* Update What's new for C# 7 (dotnet#1351)

* Update What's new for C# 7

* re-word a few awkward sentences.

* improve formatting.

* respond to review comments.

* Update F# XML documentation (dotnet#1357)

Removed extraneous stars (bad formatting).

* Fix date format to be mm/dd/yyyy (dotnet#1360)

It was causing the wrong publication date.

* fix typo in class name (dotnet#1361)

As reported on PR dotnet#1351
  • Loading branch information
alexinea committed Dec 29, 2016
1 parent 7e0e5ea commit 22b6431
Show file tree
Hide file tree
Showing 8,765 changed files with 477,632 additions and 4,090 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
63 changes: 63 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
###############################################################################
# Set default behavior to automatically normalize line endings.
###############################################################################
* text=auto

###############################################################################
# Set default behavior for command prompt diff.
#
# This is need for earlier builds of msysgit that does not have it on by
# default for csharp files.
# Note: This is only used by command line
###############################################################################
#*.cs diff=csharp

###############################################################################
# Set the merge driver for project and solution files
#
# Merging from the command prompt will add diff markers to the files if there
# are conflicts (Merging from VS is not affected by the settings below, in VS
# the diff markers are never inserted). Diff markers may cause the following
# file extensions to fail to load in VS. An alternative would be to treat
# these files as binary and thus will always conflict and require user
# intervention with every merge. To do so, just uncomment the entries below
###############################################################################
#*.sln merge=binary
#*.csproj merge=binary
#*.vbproj merge=binary
#*.vcxproj merge=binary
#*.vcproj merge=binary
#*.dbproj merge=binary
#*.fsproj merge=binary
#*.lsproj merge=binary
#*.wixproj merge=binary
#*.modelproj merge=binary
#*.sqlproj merge=binary
#*.wwaproj merge=binary

###############################################################################
# behavior for image files
#
# image files are treated as binary by default.
###############################################################################
#*.jpg binary
#*.png binary
#*.gif binary

###############################################################################
# diff behavior for common document formats
#
# Convert binary document formats to text before diffing them. This feature
# is only available from the command line. Turn it on by uncommenting the
# entries below.
###############################################################################
#*.doc diff=astextplain
#*.DOC diff=astextplain
#*.docx diff=astextplain
#*.DOCX diff=astextplain
#*.dot diff=astextplain
#*.DOT diff=astextplain
#*.pdf diff=astextplain
#*.PDF diff=astextplain
#*.rtf diff=astextplain
#*.RTF diff=astextplain
11 changes: 8 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -205,12 +205,17 @@ samples/AngularSample/src/AngularSample/wwwroot/lib
project.lock.json
samples/WebApplication1/src/WebApplication1/wwwroot/lib/

/samples/linq/csharp/aggregate/*.xproj
/samples/linq/csharp/aggregate/*.sln
/samples/core/linq/csharp/aggregate/*.xproj
/samples/core/linq/csharp/aggregate/*.sln

_site/
api_ref/
api_src/
api/
_themes/
log/
.optemp/
.openpublishing.buildcore.ps1
# Spelling add-on file for VS Code.
spell.json
samples/framework/docker/MVCRandomAnswerGenerator/containerImage
.DS_Store
34 changes: 34 additions & 0 deletions .localization-config
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"Filters": [
{
"Files": [
"**/*.md"
],
"Priorities": [
{
"Priority": "ht",
"Locales": [
"cs-cz",
"de-de",
"es-es",
"fr-fr",
"it-it",
"ja-jp",
"ko-kr",
"pl-pl",
"pt-br",
"ru-ru",
"tr-tr",
"zh-cn",
"zh-tw"
],
"Type": "ht"
}
]
}
],
"IncludeDependencies": true,
"AutoPush": true,
"XliffVersion": "1.2",
"UseJavascriptMarkdownTransformer": true
}
83 changes: 50 additions & 33 deletions .openpublishing.publish.config.json
Original file line number Diff line number Diff line change
@@ -1,36 +1,53 @@
{
"need_generate_pdf": false,
"need_generate_intellisense": false,
"git_repository_branch_open_to_public_contributors": "master",
"git_repository_url_open_to_public_contributors": "https://github.com/dotnet/core-docs",
"docsets_to_publish": [
{
"docset_name": "core-docs",
"build_source_folder": ".",
"build_output_subfolder": ".",
"locale": "en-us",
"version": 0,
"open_to_public_contributors": true,
"type_mapping": {
"Conceptual": "Content",
"ManagedReference": "Content",
"RestApi": "Content"
},
"build_entry_point": "docs"
}
],
"notification_subscribers": [],
"skip_source_output_uploading": false,
"dependent_repositories": [
{
"path_to_root": "_themes",
"url": "https://github.com/Microsoft/templates.docs.msft",
"branch": "master"
"need_generate_pdf": false,
"need_generate_intellisense": false,
"need_preview_pull_request": true,
"need_pr_comments": false,
"need_generate_pdf_url_template": true,
"git_repository_branch_open_to_public_contributors": "master",
"git_repository_url_open_to_public_contributors": "https://github.com/dotnet/core-docs",
"branch_target_mapping": {
"live": [
"Publish",
"Pdf"
],
"master": [
"Publish",
"Pdf"
]
},
{
"path_to_root": "api_ref",
"url": "https://github.com/docascode/coreapi.git",
"branch": "master"
}
]
"docsets_to_publish": [{
"docset_name": "core-docs",
"build_source_folder": ".",
"build_output_subfolder": ".",
"locale": "en-us",
"version": 0,
"open_to_public_contributors": true,
"type_mapping": {
"Conceptual": "Content",
"ManagedReference": "Content",
"RestApi": "Content"
},
"build_entry_point": "docs"
}],
"notification_subscribers": [],
"Targets": {
"Pdf": {
"template_folder": "_themes.pdf"
}
},
"skip_source_output_uploading": false,
"dependent_repositories": [{
"path_to_root": "_themes",
"url": "https://github.com/Microsoft/templates.docs.msft",
"branch": "master"
}, {
"path_to_root": "api_ref",
"url": "https://github.com/docascode/coreapi.git",
"branch": "master"
}, {
"path_to_root": "_themes.pdf",
"url": "https://github.com/Microsoft/templates.docs.msft.pdf",
"branch": "master"
}]
}
19 changes: 19 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
language: csharp

matrix:
include:
- os: linux # Ubuntu 14.04
dist: trusty
sudo: required
dotnet: 1.0.0-preview2-003121
- os: osx # OSX 10.11
osx_image: xcode7.2
dotnet: 1.0.0-preview2-003121

script:
# Run a new console app
- mkdir -p "test/test-dotnet-new" && pushd "test/test-dotnet-new"
- dotnet new
- dotnet restore
- dotnet --verbose run a b
- popd
37 changes: 16 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Contributing
============
# Contributing

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

In this topic, you'll see the basic process for adding or updating content in the [.NET documentation site](https://docs.microsoft.com/dotnet). For the detailed step-by-step process and instructions, please see the [official guide](https://github.com/Microsoft/Docs/blob/master/readme.md) in the [Microsoft/Docs](https://github.com/Microsoft/Docs) repo.
In this topic, you'll see the basic process for adding or updating content in the [.NET documentation site](https://docs.microsoft.com/dotnet).

In this topic, we'll cover:

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 All @@ -89,15 +88,15 @@ There are several ways to use DocFX, and most of them are covered in the [DocFX
The following instructions use the [command-line based](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) version of the tool.
If you are comfortable with other ways listed on the link above, feel free to use those.

**Note:** please note that as of now, DocFX requires the .NET Framework on Windows or Mono for Linux or macOS. We'll be working towards porting it to .NET Core in the future.
**Note:** Currently DocFX requires the .NET Framework on Windows or Mono (for Linux or macOS). We hope to port it to .NET Core in the future.

You can build and preview the resulting site locally using a built-in web server. Navigate to the core-docs folder on your machine and type the following command:

```
docfx .\docfx.json --serve
docfx -t default --serve
```

This starts the local preview on [localhost:8080](http://localhost:8080). You can then view the changes by going to `http://localhost:8080/docs/[path]`, such as http://localhost:8080/docs/articles/.
This starts the local preview on [localhost:8080](http://localhost:8080). You can then view the changes by going to `http://localhost:8080/[path]`, such as http://localhost:8080/articles/welcome.html.

**Note:** the local preview currently doesn't contain any themes at the moment so the look and feel won't be the same as in the documentation site. We're working towards fixing that experience.

Expand All @@ -110,25 +109,21 @@ All samples should be complete applications or libraries. Where the sample creat
it should include unit tests or an application that lets readers run the code.

The samples are organized in directories that match the directories under
docs in this repo:
docs in this repo.

- `getting-started` contains getting started samples.
- `core` contains .NET Core samples. These are referenced by topics under `/docs/core`.

* Each top-level section of our documentation contains a "getting-started" or "tutorials" section. These topics and their associated samples represent the first look(s) at a topic area. If your sample's goal is to help beginners get started with the platform or the technology, place your sample under `samples/getting-started`. There should be a directory that matches the section for your tutorial (such as `samples/getting-started/csharp`), but if not, simply create a new folder.
* The `core` directory contains samples that highlight .NET Core. The purpose of your sample should be to teach developers something about .NET Core. This includes the framework packaging, the new tooling, or the cross-platform experience. Our CI build server builds these samples on multiple supported platforms. Therefore, every sample must be configured to build on Linux, Mac, and Windows.

- `core-projects` contains .NET Core samples. These are referenced by topics under `/docs/core`.
- `csharp` contains C# language samples. These are referenced by topics under `docs/csharp`.

* The `core-projects` directory contains samples that highlight .NET Core. The purpose of your sample should be to teach developers something about .NET Core. This includes the framework packaging, the new tooling, or the cross-platform experience.
* The `csharp` directory contains samples where the purpose is to explain the C# language. While these samples will use frameworks and libraries, their focus is on the C# language. Our CI build server builds these samples on multiple supported platforms. Therefore, every sample must be configured to build on Linux, Mac, and Windows.

- `csharp-language` contains C# language samples. These are referenced by topics under `docs/csharp`.
- `framework` contains .NET Framework samples. These are referenced by topics under many different locations in the documentation. These samples build only on Windows where the .NET framework and Visual Studio are installed.

* The `csharp-language` directory contains samples where the purpose is to explain the C# language. While these samples will use frameworks and libraries, their focus is on the C# language.
* The `framework` directory contains samples that highlight .NET with platform dependencies. These may include migration samples, platform specific samples, or other samples that require the framework or the Windows based tools. Our CI build server builds these samples on Windows only. Do not place any samples here that should be checked for cross-platform builds.

- `linq` contains all the 101 LINQ samples that were originally created when LINQ was developed. These don't have topics associated with them yet.

* The `linq` directory contains samples that are specific to understanding the concepts and implementation behind Language Integrated Query (LINQ). These samples should be focused on the language support and library methods that are specific to LINQ. Other samples my use the LINQ libraries, but unless they are focused on explaining LINQ concepts, they should be in one of the other directories.

We will expand these directories as the core-docs repository adds new content.
We will expand these directories as the core-docs repository adds new content. For example, we will add Xamarin directories, like `xamarin-ios` and `xamarin-android` directories.

Sample code may fit more than one of these areas. In those cases, place the sample so it matches
the topics you are covering in your documents. Ask yourself what readers will learn from reading
Expand All @@ -143,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).
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
.NET Core Documentation
=======================
#.NET Documentation

This repo contains work-in-progress documentation for .NET Core. Please see the [Contributing Guide](CONTRIBUTING.md) to get set up and take a look at our [issues list](https://github.com/dotnet/core-docs/issues).
This repo contains work-in-progress documentation for .NET. To contribute, see the [Contributing Guide](CONTRIBUTING.md) and the [issues list](https://github.com/dotnet/docs/issues).

We very much welcome contributions to help us provide a complete set of .NET Core docs sooner. Feel free to use (copy/paste) documentation from [.NET Framework docs](https://msdn.microsoft.com/library/w0x726c2.aspx) as a starting point for .NET Core docs. We will likely port higher-quality .NET Core content to the .NET Framework docs, such that investments in this repo have a broader impact than .NET Core users. We expect 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.
We welcome contributions to help us improve and complete the .NET docs. Feel free to copy/paste documentation from [.NET Framework docs](https://msdn.microsoft.com/library/w0x726c2.aspx) as a starting point for .NET docs. 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.

Samples
Samples Build Status
===
Current build status for .NET core samples:

![](https://dendeli-ms.visualstudio.com/_apis/public/build/definitions/9fc8ed28-e0a3-4cde-b7a6-a977d004e315/1/badge)

| Framework | Ubuntu 16.04 (x64) | Windows Server 2012 R2 (x64) |
| ------------- |------------| -----|
| .NET Core | [![Build Status](http://seoul.westus.cloudapp.azure.com/buildStatus/icon?job=dotnetcore-samples-ubuntu1604-x64)](http://seoul.westus.cloudapp.azure.com/job/dotnetcore-samples-ubuntu1604-x64/) | [![Build Status](http://seoul.westus.cloudapp.azure.com/buildStatus/icon?job=dotnetcore-samples-windows2012-x64)](http://seoul.westus.cloudapp.azure.com/job/dotnetcore-samples-windows2012-x64/) |
Loading

0 comments on commit 22b6431

Please sign in to comment.