Skip to content

Commit d67ad12

Browse files
tgleetglee
committed
Merge branch 'master' of github.com:MicrosoftDocs/visualstudio-docs-pr into tglee-vsmetapatch
2 parents 3aae059 + 62c1e49 commit d67ad12

26 files changed

+503
-338
lines changed

‎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)

‎connected-environment/how-to/use-a-custom-nuget-feed.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/ca1701-resource-string-compound-words-should-be-cased-correctly.md

Lines changed: 54 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,67 @@
11
---
22
title: "CA1701: Resource string compound words should be cased correctly | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
7-
ms.technology:
8-
- "vs-ide-code-analysis"
9-
ms.tgt_pltfrm: ""
10-
ms.topic: "article"
11-
f1_keywords:
3+
ms.date: 03/28/2018
4+
ms.technology: vs-ide-code-analysis
5+
ms.topic: reference
6+
f1_keywords:
127
- "ResourceStringCompoundWordsShouldBeCasedCorrectly"
138
- "CA1701"
14-
helpviewer_keywords:
9+
helpviewer_keywords:
1510
- "CA1701"
1611
- "ResourceStringCompoundWordsShouldBeCasedCorrectly"
1712
ms.assetid: 4ddbe09f-24b8-4c47-9373-a06f4487ca0d
18-
caps.latest.revision: 24
1913
author: "gewarren"
2014
ms.author: "gewarren"
2115
manager: ghogen
22-
ms.workload:
16+
ms.workload:
2317
- "multiple"
2418
---
2519
# CA1701: Resource string compound words should be cased correctly
26-
|||
27-
|-|-|
28-
|TypeName|ResourceStringCompoundWordsShouldBeCasedCorrectly|
29-
|CheckId|CA1701|
30-
|Category|Microsoft.Naming|
31-
|Breaking Change|Non-breaking|
32-
33-
## Cause
34-
A resource string contains a compound word that does not appear to be cased correctly.
35-
36-
## Rule Description
37-
Each word in the resource string is split into tokens that are based on the casing. Each contiguous two-token combination is checked by the Microsoft spelling checker library. If recognized, the word produces a violation of the rule. Examples of compound words that cause a violation are "CheckSum" and "MultiPart", which should be cased as "Checksum" and "Multipart", respectively. Due to previous common usage, several exceptions are built into the rule, and several single words are flagged, such as "Toolbar" and "Filename", that should be cased as two distinct words. In this example, "ToolBar" and "FileName" would be flagged.
38-
39-
Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.
40-
41-
## How to Fix Violations
42-
Change the word so that it is cased correctly.
43-
44-
## When to Suppress Warnings
45-
It is safe to suppress a warning from this rule if both parts of the compound word are recognized by the spelling dictionary and the intent is to use two words.
46-
47-
You can also add compound words to a custom dictionary for the spelling checker. Words in the custom dictionary do not cause violations. For more information, see [How to: Customize the Code Analysis Dictionary](../code-quality/how-to-customize-the-code-analysis-dictionary.md).
48-
49-
## Related Rules
50-
[CA1702: Compound words should be cased correctly](../code-quality/ca1702-compound-words-should-be-cased-correctly.md)
51-
52-
[CA1709: Identifiers should be cased correctly](../code-quality/ca1709-identifiers-should-be-cased-correctly.md)
53-
54-
[CA1708: Identifiers should differ by more than case](../code-quality/ca1708-identifiers-should-differ-by-more-than-case.md)
55-
56-
## See Also
57-
[Capitalization Conventions](/dotnet/standard/design-guidelines/capitalization-conventions)
58-
[Naming Guidelines](/dotnet/standard/design-guidelines/naming-guidelines)
20+
21+
|||
22+
|-|-|
23+
|TypeName|ResourceStringCompoundWordsShouldBeCasedCorrectly|
24+
|CheckId|CA1701|
25+
|Category|Microsoft.Naming|
26+
|Breaking Change|Non-breaking|
27+
28+
## Cause
29+
30+
A resource string contains a compound word that does not appear to be cased correctly.
31+
32+
## Rule description
33+
34+
Each word in the resource string is split into tokens that are based on the casing. Each contiguous two-token combination is checked by the Microsoft spelling checker library. If recognized, the word produces a violation of the rule. Examples of compound words that cause a violation are "CheckSum" and "MultiPart", which should be cased as "Checksum" and "Multipart", respectively. Due to previous common usage, several exceptions are built into the rule, and several single words are flagged, such as "Toolbar" and "Filename", that should be cased as two distinct words. In this example, "ToolBar" and "FileName" would be flagged.
35+
36+
Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.
37+
38+
## How to fix violations
39+
40+
Change the word so that it is cased correctly.
41+
42+
## Change the dictionary language
43+
44+
By default, the English (en) version of the spelling checker is used. If you want to change the language of the spelling checker, you can do so by adding one of the following attributes to your *AssemblyInfo.cs* or *AssemblyInfo.vb* file:
45+
46+
- Use <xref:System.Reflection.AssemblyCultureAttribute> to specify the culture if your resources are in a satellite assembly.
47+
- Use <xref:System.Resources.NeutralResourcesLanguageAttribute> to specify the *neutral culture* of your assembly if your resources are in the same assembly as your code.
48+
49+
> [!IMPORTANT]
50+
> If you set the culture to anything other than an English-based culture, this code analysis rule is silently disabled.
51+
52+
## When to suppress warnings
53+
54+
It is safe to suppress a warning from this rule if both parts of the compound word are recognized by the spelling dictionary and the intent is to use two words.
55+
56+
You can also add compound words to a custom dictionary for the spelling checker. Words in the custom dictionary do not cause violations. For more information, see [How to: Customize the Code Analysis Dictionary](../code-quality/how-to-customize-the-code-analysis-dictionary.md).
57+
58+
## Related rules
59+
60+
- [CA1702: Compound words should be cased correctly](../code-quality/ca1702-compound-words-should-be-cased-correctly.md)
61+
- [CA1709: Identifiers should be cased correctly](../code-quality/ca1709-identifiers-should-be-cased-correctly.md)
62+
- [CA1708: Identifiers should differ by more than case](../code-quality/ca1708-identifiers-should-differ-by-more-than-case.md)
63+
64+
## See also
65+
66+
- [Capitalization Conventions](/dotnet/standard/design-guidelines/capitalization-conventions)
67+
- [Naming Guidelines](/dotnet/standard/design-guidelines/naming-guidelines)

‎docs/code-quality/ca1702-compound-words-should-be-cased-correctly.md

Lines changed: 57 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,70 @@
11
---
22
title: "CA1702: Compound words should be cased correctly | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
7-
ms.technology:
8-
- "vs-ide-code-analysis"
9-
ms.tgt_pltfrm: ""
10-
ms.topic: "article"
11-
f1_keywords:
3+
ms.date: 03/28/2018
4+
ms.technology: vs-ide-code-analysis
5+
ms.topic: reference
6+
f1_keywords:
127
- "CA1702"
138
- "CompoundWordsShouldBeCasedCorrectly"
14-
helpviewer_keywords:
9+
helpviewer_keywords:
1510
- "CA1702"
1611
- "CompoundWordsShouldBeCasedCorrectly"
1712
ms.assetid: 05481245-7ad8-48c3-a456-3aa44b6160a6
18-
caps.latest.revision: 20
1913
author: "gewarren"
2014
ms.author: "gewarren"
2115
manager: ghogen
22-
ms.workload:
16+
ms.workload:
2317
- "multiple"
2418
---
2519
# CA1702: Compound words should be cased correctly
26-
|||
27-
|-|-|
28-
|TypeName|CompoundWordsShouldBeCasedCorrectly|
29-
|CheckId|CA1702|
30-
|Category|Microsoft.Naming|
31-
|Breaking Change|Breaking- when fired on assemblies.<br /><br /> Non-breaking - when fired on type parameters.|
32-
33-
## Cause
34-
The name of an identifier contains multiple words and at least one of the words appears to be a compound word that is not cased correctly.
35-
36-
## Rule Description
37-
The name of the identifier is split into words that are based on the casing. Each contiguous two-word combination is checked by the Microsoft spelling checker library. If it is recognized, the identifier produces a violation of the rule. Examples of compound words that cause a violation are "CheckSum" and "MultiPart", which should be cased as "Checksum" and "Multipart", respectively. Due to previous common usage, several exceptions are built into the rule, and several single words are flagged, such as "Toolbar" and "Filename", that should be cased as two distinct words (in this case, "ToolBar" and "FileName").
38-
39-
Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.
40-
41-
## How to Fix Violations
42-
Change the name so that it is cased correctly.
43-
44-
## When to Suppress Warnings
45-
It is safe to suppress a warning from this rule if both parts of the compound word are recognized by the spelling dictionary and the intent is to use two words.
46-
47-
## Related Rules
48-
[CA1701: Resource string compound words should be cased correctly](../code-quality/ca1701-resource-string-compound-words-should-be-cased-correctly.md)
49-
50-
[CA1709: Identifiers should be cased correctly](../code-quality/ca1709-identifiers-should-be-cased-correctly.md)
51-
52-
[CA1708: Identifiers should differ by more than case](../code-quality/ca1708-identifiers-should-differ-by-more-than-case.md)
53-
54-
## See Also
55-
[Naming Guidelines](/dotnet/standard/design-guidelines/naming-guidelines)
56-
[Capitalization Conventions](/dotnet/standard/design-guidelines/capitalization-conventions)
20+
21+
|||
22+
|-|-|
23+
|TypeName|CompoundWordsShouldBeCasedCorrectly|
24+
|CheckId|CA1702|
25+
|Category|Microsoft.Naming|
26+
|Breaking Change|Breaking- when fired on assemblies.<br /><br /> Non-breaking - when fired on type parameters.|
27+
28+
## Cause
29+
30+
The name of an identifier contains multiple words, and at least one of the words appears to be a compound word that is not cased correctly.
31+
32+
## Rule description
33+
34+
The name of the identifier is split into words that are based on the casing. Each contiguous two-word combination is checked by the Microsoft spelling checker library. If it is recognized, the identifier produces a violation of the rule. Examples of compound words that cause a violation are "CheckSum" and "MultiPart", which should be cased as "Checksum" and "Multipart", respectively. Due to previous common usage, several exceptions are built into the rule, and several single words are flagged, such as "Toolbar" and "Filename", that should be cased as two distinct words (in this case, "ToolBar" and "FileName").
35+
36+
Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.
37+
38+
## How to fix violations
39+
40+
Change the name so that it is cased correctly.
41+
42+
## Language
43+
44+
The spell checker currently checks only against English-based culture dictionaries. You can change the culture of your project in the project file, by adding the **CodeAnalysisCulture** element.
45+
46+
For example:
47+
48+
```xml
49+
<Project ...>
50+
<PropertyGroup>
51+
<CodeAnalysisCulture>en-AU</CodeAnalysisCulture>
52+
```
53+
54+
> [!IMPORTANT]
55+
> If you set the culture to anything other than an English-based culture, this code analysis rule is silently disabled.
56+
57+
## When to suppress warnings
58+
59+
It is safe to suppress a warning from this rule if both parts of the compound word are recognized by the spelling dictionary, and the intent is to use two words.
60+
61+
## Related rules
62+
63+
- [CA1701: Resource string compound words should be cased correctly](../code-quality/ca1701-resource-string-compound-words-should-be-cased-correctly.md)
64+
- [CA1709: Identifiers should be cased correctly](../code-quality/ca1709-identifiers-should-be-cased-correctly.md)
65+
- [CA1708: Identifiers should differ by more than case](../code-quality/ca1708-identifiers-should-differ-by-more-than-case.md)
66+
67+
## See also
68+
69+
- [Naming Guidelines](/dotnet/standard/design-guidelines/naming-guidelines)
70+
- [Capitalization Conventions](/dotnet/standard/design-guidelines/capitalization-conventions)

0 commit comments

Comments
 (0)