Skip to content

Commit 38d7b9f

Browse files
author
Kraig Brockschmidt
committed
2 parents a53adcd + 161d35b commit 38d7b9f

File tree

86 files changed

+865
-563
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+865
-563
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@
9797
"redirect_url": "/visualstudio/code-quality/code-analysis-for-c-cpp-overview",
9898
"redirect_document_id": false
9999
},
100+
{
101+
"source_path": "docs/code-quality/code-analysis-rule-set-reference.md",
102+
"redirect_url": "/visualstudio/code-quality/managed-minimun-rules-rule-set-for-managed-code",
103+
"redirect_document_id": false
104+
},
100105
{
101106
"source_path": "docs/code-quality/creating-and-using-code-analysis-check-in-policies.md",
102107
"redirect_url": "/visualstudio/code-quality/how-to-create-or-update-standard-code-analysis-check-in-policies",

connected-environment/TOC.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030

3131
# How to
3232
##[Share a development environment](how-to/share-dev-environment.md)
33+
##[Use a custom NuGet feed](how-to/use-a-custom-nuget-feed.md)
3334
##[Use kubectl with Visual Studio Connected Environment](how-to/use-kubectl-with-vsce.md)
3435

3536
# [Troubleshoot](troubleshooting.md)
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "How to use a custom NuGet feed in a connected environment| Microsoft Docs"
3+
author: "johnsta"
4+
ms.author: "johnsta"
5+
ms.date: "03/27/2018"
6+
ms.topic: "article"
7+
description: "Use a custom NuGet feed to access and use NuGet packages in a connected environment."
8+
keywords: "Docker, Kubernetes, Azure, AKS, Azure Container Service, containers"
9+
manager: "ghogen"
10+
---
11+
# Use a custom NuGet feed in a connected environment
12+
13+
A NuGet feed provides a convenient way to include package sources in a project. Connected Environment will need to be able to access this feed in order for dependencies to be properly installed in the Docker container.
14+
15+
To set up a NuGet feed:
16+
1. Add a [package reference](https://docs.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files) in the `*.csproj` file under the `PackageReference` node.
17+
18+
```xml
19+
<ItemGroup>
20+
<!-- ... -->
21+
<PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0" />
22+
<!-- ... -->
23+
</ItemGroup>
24+
```
25+
26+
2. Create a [NuGet.Config](https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file) file in the project folder.
27+
* Use the `packageSources` section to reference your NuGet feed location. Important: The NuGet feed must be publicly accessible.
28+
* Use the `packageSourceCredentials` section to configure username and password credentials.
29+
30+
```xml
31+
<packageSources>
32+
<add key="Contoso" value="https://contoso.com/packages/" />
33+
</packageSources>
34+
35+
<packageSourceCredentials>
36+
<Contoso>
37+
<add key="Username" value="[email protected]" />
38+
<add key="ClearTextPassword" value="33f!!lloppa" />
39+
</Contoso>
40+
</packageSourceCredentials>
41+
```
42+
43+
3. If you're using source code control:
44+
- Reference `NuGet.Config` in your `.gitignore` file so you don't accidentally commit credentials to your source repository.
45+
- Open the `vsce.yaml` file in your project, and locate the `build` section, and insert the following snippet to ensure that the `NuGet.Config` file will be synced to Azure so that it used during the container image build process. (By default, Connected Environment does not synchronize files that match `.gitignore` and `.dockerignore` rules.)
46+
47+
```yaml
48+
build:
49+
useGitIgnore: true
50+
ignore:
51+
- “!NuGet.Config”
52+
```
53+
54+
55+
## Next steps
56+
57+
Once you have completed the above steps, the next time you run `vsce up` (or hit `F5` in VSCode or Visual Studio), Connected Environment will synchronize the `NuGet.Config` file to Azure, which is then utilized by `dotnet restore` to install package dependencies in the container.
58+

docs/ai/tensorflow-vm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ms.workload:
1616

1717
# Train a TensorFlow model in the cloud
1818

19-
In this tutorial, we will train a TensorFlow model using the [MNIST dataset](http://yann.lecun.com/exdb/mnist/) in an Azure [Deep Learning](https://docs.microsoft.com/azure/machine-learning/data-science-virtual-machine/deep-learning-dsvm-overview) virtual machine.
19+
In this tutorial, we will train a TensorFlow model using the [MNIST dataset](http://yann.lecun.com/exdb/mnist/) on an Azure [Deep Learning](https://docs.microsoft.com/azure/machine-learning/data-science-virtual-machine/deep-learning-dsvm-overview) virtual machine.
2020

2121
The MNIST database has a training set of 60,000 examples, and a test set of 10,000 examples of handwritten digits.
2222

@@ -38,7 +38,7 @@ echo -e ". /etc/profile\n$(cat ~/.bashrc)" > ~/.bashrc
3838

3939
### Download sample code
4040

41-
Download this [GitHub repository](https://github.com/Microsoft/samples-for-ai) containing samples for getting started with deep learning across TensorFlow, CNTK, Theano, and more.
41+
Download this [GitHub repository](https://github.com/Microsoft/samples-for-ai) containing samples for getting started with deep learning on TensorFlow, CNTK, Theano, and more.
4242

4343
## Open project
4444

@@ -80,4 +80,4 @@ Stop the VM if you plan on using it in the near future. If you are finished with
8080

8181
```azurecli-interactive
8282
az group delete --name myResourceGroup
83-
```
83+
```

docs/code-quality/TOC.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Overview
22
## [Code Analysis for Managed Code](code-analysis-for-managed-code-overview.md)
3+
## [Roslyn Analyzers](roslyn-analyzers-overview.md)
34
## [Code Analysis for C/C++](code-analysis-for-c-cpp-overview.md)
45
## [Measure Code Maintainability with Code Metrics](code-metrics-values.md)
56
# Quickstarts
@@ -11,20 +12,21 @@
1112
## [Configure and Use a Custom Rule Set](walkthrough-configuring-and-using-a-custom-rule-set.md)
1213
# How-to guides
1314
## Code Analysis for Managed Code
14-
### [Enable and Disable Automatic Code Analysis for Managed Code](how-to-enable-and-disable-automatic-code-analysis-for-managed-code.md)
15-
### [Enable and Disable Full Solution Analysis for Managed Code](how-to-enable-and-disable-full-solution-analysis-for-managed-code.md)
15+
### [Install Roslyn Analyzers](install-roslyn-analyzers.md)
16+
### [Configure and Use Roslyn Analyzers](use-roslyn-analyzers.md)
17+
### [Enable Automatic Code Analysis](how-to-enable-and-disable-automatic-code-analysis-for-managed-code.md)
18+
### [Enable Full Solution Analysis](how-to-enable-and-disable-full-solution-analysis-for-managed-code.md)
1619
### [Automatic feature suspension](automatic-feature-suspension.md)
17-
### [Run Code Analysis Manually for Managed Code](how-to-run-code-analysis-manually-for-managed-code.md)
20+
### [Run Code Analysis Manually](how-to-run-code-analysis-manually-for-managed-code.md)
1821
### [Suppress Warnings](in-source-suppression-overview.md)
1922
#### [Suppress Code Analysis Warnings for Generated Code](how-to-suppress-code-analysis-warnings-for-generated-code.md)
2023
### [Customize the Code Analysis Dictionary](how-to-customize-the-code-analysis-dictionary.md)
2124
### [Anonymous Methods and Code Analysis](anonymous-methods-and-code-analysis.md)
2225
### [Create a Work Item for a Managed Code Defect](how-to-create-a-work-item-for-a-managed-code-defect.md)
2326
## Code Analysis for C/C++
24-
### [Use Rule Sets to Specify the C++ Rules to Run](using-rule-sets-to-specify-the-cpp-rules-to-run.md)
2527
### [Use the C++ Core Guidelines checkers](using-the-cpp-core-guidelines-checkers.md)
26-
### [Set Code Analysis Properties for C/C++ Projects](how-to-set-code-analysis-properties-for-c-cpp-projects.md)
27-
### [Use SAL Annotations to Reduce C/C++ Code Defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md)
28+
### [Set Code Analysis Properties](how-to-set-code-analysis-properties-for-c-cpp-projects.md)
29+
### [Use SAL Annotations to Reduce Code Defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md)
2830
#### [Understand SAL](understanding-sal.md)
2931
#### [Annotate Function Parameters and Return Values](annotating-function-parameters-and-return-values.md)
3032
#### [Annotate Function Behavior](annotating-function-behavior.md)
@@ -35,27 +37,14 @@
3537
#### [Best Practices and Examples (SAL)](best-practices-and-examples-sal.md)
3638
### [Specify Additional Code Information by Using __analysis_assume](how-to-specify-additional-code-information-by-using-analysis-assume.md)
3739
## [Use Rule Sets to Group Code Analysis Rules](using-rule-sets-to-group-code-analysis-rules.md)
38-
### [Configure Code Analysis for a Managed Code Project](how-to-configure-code-analysis-for-a-managed-code-project.md)
39-
### [Configure Code Analysis for an ASP.NET Web Application](how-to-configure-code-analysis-for-an-aspnet-web-application.md)
40-
### [Synchronize Code Project Rule Sets with Team Project Check-in Policy](how-to-synchronize-code-project-rule-sets-with-team-project-check-in-policy.md)
41-
### [Specify Managed Code Rule Sets for Multiple Projects in a Solution](how-to-specify-managed-code-rule-sets-for-multiple-projects-in-a-solution.md)
42-
### [Create Custom Code Analysis Rule Sets](creating-custom-code-analysis-rule-sets.md)
40+
### [Use Rule Sets for Managed Code](how-to-configure-code-analysis-for-a-managed-code-project.md)
41+
#### [Configure Code Analysis for an ASP.NET Web Application](how-to-configure-code-analysis-for-an-aspnet-web-application.md)
42+
#### [Specify Rule Sets for Multiple Projects](how-to-specify-managed-code-rule-sets-for-multiple-projects-in-a-solution.md)
43+
### [Use Rule Sets for C++ Code](using-rule-sets-to-specify-the-cpp-rules-to-run.md)
44+
### [Synchronize Project Rule Sets with Team Project Check-in Policy](how-to-synchronize-code-project-rule-sets-with-team-project-check-in-policy.md)
45+
### [Create Custom Rule Sets](creating-custom-code-analysis-rule-sets.md)
4346
#### [Create a Custom Rule Set](how-to-create-a-custom-rule-set.md)
44-
#### [Use the Code Analysis Rule Set Editor](working-in-the-code-analysis-rule-set-editor.md)
45-
### [Code analysis rule set reference](code-analysis-rule-set-reference.md)
46-
#### [All Rules rule set](all-rules-rule-set.md)
47-
#### [Basic Correctness Rules rule set for managed code](basic-correctness-rules-rule-set-for-managed-code.md)
48-
#### [Basic Design Guideline Rules rule set for managed code](basic-design-guideline-rules-rule-set-for-managed-code.md)
49-
#### [Extended Correctness Rules rule set for managed code](extended-correctness-rules-rule-set-for-managed-code.md)
50-
#### [Extended Design Guidelines Rules rule set for managed code](extended-design-guidelines-rules-rule-set-for-managed-code.md)
51-
#### [Globalization Rules rule set for managed code](globalization-rules-rule-set-for-managed-code.md)
52-
#### [Managed Minimun Rules rule set for managed code](managed-minimun-rules-rule-set-for-managed-code.md)
53-
#### [Managed Recommended Rules rule set for managed code](managed-recommended-rules-rule-set-for-managed-code.md)
54-
#### [Mixed Minimum Rules rule set](mixed-minimum-rules-rule-set.md)
55-
#### [Mixed Recommended Rules rule set](mixed-recommended-rules-rule-set.md)
56-
#### [Native Minimum Rules rule set](native-minimum-rules-rule-set.md)
57-
#### [Native Recommended Rules rule set](native-recommended-rules-rule-set.md)
58-
#### [Security Rules rule set for managed code](security-rules-rule-set-for-managed-code.md)
47+
#### [Use the Rule Set Editor](working-in-the-code-analysis-rule-set-editor.md)
5948
## [Create Code Analysis Check-in Policies](how-to-create-or-update-standard-code-analysis-check-in-policies.md)
6049
### [Implement Custom Code Analysis Check-in Policies for Managed Code](implementing-custom-code-analysis-check-in-policies-for-managed-code.md)
6150
### [Enforce Maintainable Code](how-to-enforce-maintainable-code-with-a-code-analysis-check-in-policy.md)
@@ -64,6 +53,20 @@
6453
### [Generate Code Metrics Data](how-to-generate-code-metrics-data.md)
6554
### [Work with Code Metrics Data](working-with-code-metrics-data.md)
6655
# Reference
56+
## Rule sets
57+
### [All Rules rule set](all-rules-rule-set.md)
58+
### [Basic Correctness Rules rule set for managed code](basic-correctness-rules-rule-set-for-managed-code.md)
59+
### [Basic Design Guideline Rules rule set for managed code](basic-design-guideline-rules-rule-set-for-managed-code.md)
60+
### [Extended Correctness Rules rule set for managed code](extended-correctness-rules-rule-set-for-managed-code.md)
61+
### [Extended Design Guidelines Rules rule set for managed code](extended-design-guidelines-rules-rule-set-for-managed-code.md)
62+
### [Globalization Rules rule set for managed code](globalization-rules-rule-set-for-managed-code.md)
63+
### [Managed Minimun Rules rule set for managed code](managed-minimun-rules-rule-set-for-managed-code.md)
64+
### [Managed Recommended Rules rule set for managed code](managed-recommended-rules-rule-set-for-managed-code.md)
65+
### [Mixed Minimum Rules rule set](mixed-minimum-rules-rule-set.md)
66+
### [Mixed Recommended Rules rule set](mixed-recommended-rules-rule-set.md)
67+
### [Native Minimum Rules rule set](native-minimum-rules-rule-set.md)
68+
### [Native Recommended Rules rule set](native-recommended-rules-rule-set.md)
69+
### [Security Rules rule set for managed code](security-rules-rule-set-for-managed-code.md)
6770
## [Code Analysis for Managed Code Warnings](code-analysis-for-managed-code-warnings.md)
6871
### [Code Analysis Warnings for Managed Code by CheckId](code-analysis-warnings-for-managed-code-by-checkid.md)
6972
### [Cryptography Warnings](cryptography-warnings.md)

docs/code-quality/code-analysis-for-managed-code-overview.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
11
---
2-
title: "Code Analysis for Managed Code Overview | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
2+
title: "Code analysis for managed code in Visual Studio | Microsoft Docs"
3+
ms.date: 03/26/2018
74
ms.technology: vs-ide-code-analysis
8-
ms.tgt_pltfrm: ""
9-
ms.topic: "article"
10-
f1_keywords:
5+
ms.topic: conceptual
6+
f1_keywords:
117
- "vs.projectpropertypages.codeanalysis"
12-
helpviewer_keywords:
8+
helpviewer_keywords:
139
- "code analysis, managed code"
1410
- "managed code, code analysis"
1511
author: "gewarren"
1612
ms.author: "gewarren"
1713
manager: ghogen
18-
ms.workload:
14+
ms.workload:
1915
- "dotnet"
2016
---
21-
# Code analysis for managed code overview
17+
# Overview of code analysis for managed code
18+
19+
Visual Studio 2017 analyzes managed code in two ways: with legacy *FxCop* static analysis of managed assemblies, and with .NET Compiler Platform *analyzers*. This topic covers FxCop static code analysis. To learn more about analyzing code by using .NET Compiler Platform analyzers, see [Overview of Roslyn analyzers](../code-quality/roslyn-analyzers-overview.md).
2220

2321
Code analysis for managed code analyzes managed assemblies and reports information about the assemblies, such as violations of the programming and design rules set forth in the Microsoft .NET Framework Design Guidelines.
2422

@@ -71,5 +69,6 @@ You can use the integrated features of the build system to run the analysis tool
7169

7270
## See also
7371

74-
[Using Rule Sets to Group Code Analysis Rules](../code-quality/using-rule-sets-to-group-code-analysis-rules.md)
75-
[How to: Enable and Disable Automatic Code Analysis](../code-quality/how-to-enable-and-disable-automatic-code-analysis-for-managed-code.md)
72+
- [Overview of Roslyn analyzers](../code-quality/roslyn-analyzers-overview.md)
73+
- [Using Rule Sets to Group Code Analysis Rules](../code-quality/using-rule-sets-to-group-code-analysis-rules.md)
74+
- [How to: Enable and Disable Automatic Code Analysis](../code-quality/how-to-enable-and-disable-automatic-code-analysis-for-managed-code.md)

0 commit comments

Comments
 (0)