CLI Preview 3 docs #1233
Merged
CLI Preview 3 docs #1233
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
BillWagner
requested changes
Nov 15, 2016
There was a problem hiding this comment.
Lots here. Some global points:
- We've been moving toward including code from working samples so that nothing in the text could accidentally not build. Can you switch to that method of including code samples?
- I tried to mark most of the references to project.json with a question as to whether or not they still applied. I might have missed some. We should do a quick search as this gets closer to merging.
- Some of the links are failing in the build. Until we can publish versions as branches, I think some of those should link to the LTS version of the docs. Is that right?
|
|
||
| # .NET Core Application Deployment # | ||
|
|
||
| **TODO:** all remains the same except the csproj samples need to become csproj samples |
There was a problem hiding this comment.
This TODO makes no sense to me. Did you mean project.json samples becoming csproj samples?
There was a problem hiding this comment.
This is my internal TODO. It will be removed at the end.
|
|
||
| private static void ShowWords(String s) | ||
| { | ||
| String pattern = @"\w+"; |
There was a problem hiding this comment.
Any reason not to use Array.Split() instead of a regex? You might have a bit of cleanup to do with repeated spaces or tabs but it might be simpler.
There was a problem hiding this comment.
@rpetrusha wrote the code. I'm simply changing project file references.
| Console.WriteLine("\nNo words were identified in your input."); | ||
| else | ||
| { | ||
| Console.WriteLine("\nThere are {0} words in your string:", matches.Count); |
There was a problem hiding this comment.
Please use interpolated strings here for clarity.
| { | ||
| Console.WriteLine("\nThere are {0} words in your string:", matches.Count); | ||
| for (int ctr = 0; ctr < matches.Count; ctr++) | ||
| Console.WriteLine(" #{0,2}: '{1}' at position {2}", ctr, |
|
|
||
| - You can be assured that the target system can run your .NET Core app, since you're providing the version of .NET Core that it will run on. | ||
|
|
||
| It also has a number of disadvantages: |
There was a problem hiding this comment.
From conference audience members, they seem to miss the fact that you can only build a self-contained deployment on the platform you target (meaning your Mac can build a Mac package, Windows a Windows package). I'd recommend calling this out.
| Consuming these tools requires you to add a `<DotNetCliToolReference>` element for each tool you want to use to your project file. Inside the `<DotNetCliToolReference>` element, you reference the package in which the tool resides and you specify the version you need. After running `dotnet restore`, the tool and its dependencies are restored. | ||
|
|
||
| For tools that need to load the build output of the project for execution, there is usually another dependency which is | ||
| listed under the regular dependencies in the project file. Since the Preview 3 version of the CLI uses MSBuild as its build engine, it is reccomended that these parts of the tool be written as custom MSBuild targets and tasks since that way they can take part in the overall build process. Also, they can get any and all data easily that is produced via the build, for example the location of the output files, the current configuration being built etc. All of this information in Preview 3 becomes a set of MSBuild properties that can be read from any target. We will see how to add a custom target using NuGet later in this document. |
| can use the [DNX to CLI migration](../migrating-from-dnx.md) topic to get all the details. | ||
|
|
||
| ## Extensibility | ||
| Of course, not every tool that you could use in your workflow will be part of the core CLI tools. However, .NET Core |
There was a problem hiding this comment.
suggestion: I'd reverse the clauses of the first sentence to sound stronger:
"The .NET CLI provides a set of verbs that handles many scenarios. It has an extenibility ... for your projects for scenarios that are not part of the CLI install."
| @@ -0,0 +1,78 @@ | |||
| --- | |||
| title: .NET Core Command Line Tools Preview 3 Architecture | |||
| description: Preview 3 brings about certain changes to the | |||
There was a problem hiding this comment.
looks like more was supposed to go here....
| # Moving away from project.json | ||
| The biggest change in the Preview 3 tooling for .NET Core is certainly the [move away from project.json to csproj](https://blogs.msdn.microsoft.com/dotnet/2016/05/23/changes-to-project-json/) as the project system. Preview 3 version of the command line tools is the first release of .NET Core command line tooling that does not contain any support for project.json. That means that it cannot be used to build, run or publish project.json based applications and libraries. In order to use this version of the tools, you will need to migrate your existing projects or start new ones. | ||
|
|
||
| As part of this move, the custom build engine that was developed to build project.json projects was replaced with a mature and fully capable build engine called [MSBuild](https://msdn.microsoft.com/en-us/library/dd637714.aspx). MSBuild is a well-known engine in the .NET community, since it has been a key technology since the platform's first release. Of course, because it needs to build .NET Core applications, MSBuild has been ported to .NET Core and can be used on any platform that .NET Core runs on. One of the main promises of .NET Core is that of a cross-platform development stack, and we have made sure that this move does not break that promise. |
There was a problem hiding this comment.
I'd add a link to the msbuild project: https://github.com/Microsoft/msbuild
| - `dotnet build` | ||
| - `dotnet pack` | ||
| - `dotnet restore` | ||
| - `dotnet run` |
There was a problem hiding this comment.
I find it interesting that 'dotnet run' has telemetry enabled, but 'dotnet [path-to-app]' does not. The reason should be explained.
There was a problem hiding this comment.
I thought it did explain already. The telemetry runs on dotnet commands not on the driver. maybe this can be later changed to be more specific. and then later on it goes on to explain what kind of info is being collected.
|
|
@BillWagner thanks for reviewing. I was focusing on fixing up the deltas between Preview 2 and Preview 3, especially in places where csproj and MSBuild come into picture. I think that the overall improvements to the CLI docs should be done at a later time, mostly because I'm pressed for time to finish this ASAP. I will take your feedback and open up an issue to fix up the CLI docs overall once the current state has subsided a bit. Hope that makes sense. |
|
@blackdwarf That works for me. I'll approve the PR. Can we make sure the links work in the review site before we merge? That's the one blocker I see. |
BillWagner
approved these changes
Nov 15, 2016
|
|
@BillWagner for sure, I'm just still adding stuff. As soon as I'm done with the "raw" content I will fix the build issues. |
richlander
reviewed
Nov 15, 2016
| @@ -0,0 +1,96 @@ | |||
| --- | |||
| title: dotnet-migrate command | .NET Core SDK | |||
There was a problem hiding this comment.
I noticed that "migrate" isn't listed in "dotnet --help". Agreed that this is an odd place to log that issue.
There was a problem hiding this comment.
@richlander we already have an issue on the CLI tracking that we need to update help. Good catch on that.
|
bleroy
reviewed
Nov 16, 2016
|
|
||
| Run the tests in the test1 project: | ||
|
|
||
| `dotnet test /projects/test1/project.json` |
There was a problem hiding this comment.
I don't think that should be project.json.
There was a problem hiding this comment.
we should probably scrub that folder and remove all references to project.json right?
|
New changes added. Hopefully this fixes the warnings. |
✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
OK, so one more thing is needed prior to merging and that is, do we want the folder to be here or do we want it moved somewhere else? Maybe under Also, where do we stick this in the TOC? @BillWagner @cartermp @mairaw @bleroy thoughts? |
|
I vote under |
added 10 commits
November 16, 2016 10:24
blackdwarf
force-pushed
the
cliupdatep3
branch
from
bc4e89a to
2f6acf5
Compare
|
OK, moved it and added stuff to the TOC. Also moved some nuget stuff over. Can someone give me a preview link so I can actually see how it looks like? :) |
|
The bot should give you a preview link when the build finishes. |
|
there's a giant table full of URLs for you to test above 😄 |
❌ Validation status: errors
docs/core/preview3/tools/dotnet-nuget-delete.md
:Couldn't find file docs/core/includes/warning.md.at line 18. docs/core/preview3/tools/dotnet-nuget-locals.md
:Couldn't find file docs/core/includes/warning.md.at line 18. docs/core/preview3/tools/dotnet-nuget-push.md
:Couldn't find file docs/core/includes/warning.md.at line 18. docs/core/preview3/deploying/index.md
docs/core/preview3/tools/csproj.md
docs/core/preview3/tools/dotnet-publish.md
docs/core/preview3/tools/dotnet-test.md
docs/toc.md
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
❌ Validation status: errors
docs/core/preview3/tools/dotnet-nuget-delete.md
:Couldn't find file docs/core/includes/warning.md.at line 18. docs/core/preview3/tools/dotnet-nuget-locals.md
:Couldn't find file docs/core/includes/warning.md.at line 18. docs/core/preview3/tools/dotnet-nuget-push.md
:Couldn't find file docs/core/includes/warning.md.at line 18. docs/core/preview3/deploying/index.md
docs/core/preview3/tools/csproj.md
docs/core/preview3/tools/dotnet-publish.md
docs/core/preview3/tools/dotnet-test.md
docs/toc.md
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/toc.md | View | Details | |
| docs/core/preview3/deploying/index.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/csproj.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dependencies.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-build.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-install-script.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-migrate.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-msbuild.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-new.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-nuget-delete.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-nuget-locals.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-nuget-push.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-pack.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-publish.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-restore.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-run.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-test.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/extensibility.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/global-json.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/index.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/layering.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/telemetry.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/using-ci-with-cli.md | ✅Succeeded | View | Details |
docs/toc.md
- Line Unspecified: [Warning] Invalid file link:(~/docs/library-with-visual-studio-2017.md).
- Line Unspecified: [Warning] Invalid file link:(~/docs/core/preview3/index.md).
- Line Unspecified: [Warning] Invalid file link:(~/docs/testing-library-with-visual-studio-2017.md).
- Line Unspecified: [Warning] Invalid file link:(~/docs/consuming-library-with-visual-studio-2017.md).
For more details, please refer to the build report.
Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.
|
🎉 |
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/toc.md | View | Details | |
| docs/core/preview3/deploying/index.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/csproj.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dependencies.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-build.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-install-script.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-migrate.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-msbuild.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-new.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-nuget-delete.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-nuget-locals.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-nuget-push.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-pack.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-publish.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-restore.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-run.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet-test.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/dotnet.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/extensibility.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/global-json.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/index.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/layering.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/telemetry.md | ✅Succeeded | View | Details |
| docs/core/preview3/tools/using-ci-with-cli.md | ✅Succeeded | View | Details |
docs/toc.md
- Line Unspecified: [Warning] Invalid file link:(~/docs/library-with-visual-studio-2017.md).
- Line Unspecified: [Warning] Invalid file link:(~/docs/testing-library-with-visual-studio-2017.md).
- Line Unspecified: [Warning] Invalid file link:(~/docs/consuming-library-with-visual-studio-2017.md).
For more details, please refer to the build report.
Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.
alexinea
added a commit
to dotnetcore-internal/core-doc-cn
that referenced
this pull request
Dec 29, 2016
* 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating relevant docs for Preview 3 (MSBuild-based) release of the CLI
Fixes #958. Fixes #959.
Summary
This PR does the following:
cli-preview3<PackageReference>.Needed stuff:
Suggested Reviewers
@mairaw @BillWagner @bleroy