You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to the Visual Studio documentation!
38
4
39
-
In this topic, you'll see the basic process for adding or updating content in the [Visual Studio documentation site](https://docs.microsoft.com/visualstudio).
5
+
In this topic, you'll see the basic process for adding or updating content in the [Visual Studio documentation site](https://docs.microsoft.com/visualstudio).
40
6
41
-
In this topic, we'll cover:
7
+
In this topic, we'll cover:
42
8
43
-
*[Process for contributing](#process-for-contributing)
9
+
*[Process for contributing](#process-for-contributing)
44
10
*[Guidance checklist](#guidance-checklist)
45
11
*[Building the docs](#building-the-docs)
46
12
*[Contributing to samples](#contributing-to-samples)
@@ -57,7 +23,7 @@ You can skip this first step for small changes.
57
23
58
24
**Step 3:** Create a `branch` for your article.
59
25
60
-
**Step 4:** Write your article.
26
+
**Step 4:** Write your article.
61
27
62
28
If it's a new topic, you can use this [template file](./styleguide/template.md) as your starting point. It contains the writing guidelines and also explains the metadata required for each article, such as author information.
63
29
@@ -82,11 +48,11 @@ If your PR is addressing an existing issue, add the `Fixes #Issue_Number` keywor
82
48
83
49
The Visual Studio team will review your PR and let you know if the change looks good or if there are any other updates/changes necessary in order to approve it.
84
50
85
-
**Step 6:** Make any necessary updates to your branch as discussed with the team.
51
+
**Step 6:** Make any necessary updates to your branch as discussed with the team.
86
52
87
-
The maintainers will merge your PR into the master branch once feedback has been applied and your change looks good.
53
+
The maintainers will merge your PR into the master branch once feedback has been applied and your change looks good.
88
54
89
-
On a certain cadence, we push all commits from master branch into the live branch and then you'll be able to see your contribution live at https://docs.microsoft.com/visualstudio/.
55
+
On a certain cadence, we push all commits from master branch into the live branch and then you'll be able to see your contribution live at https://docs.microsoft.com/visualstudio/.
90
56
91
57
## DOs and DON'Ts
92
58
@@ -96,34 +62,34 @@ Below is a short list of guiding rules that you should keep in mind when you are
96
62
-**DO** read the [style guide](./styleguide/template.md) and [voice and tone](./styleguide/voice-tone.md) guidelines.
97
63
-**DO** use the [template](./styleguide/template.md) file as the starting point of your work.
98
64
-**DO** create a separate branch on your fork before working on the articles.
99
-
-**DO** follow the [GitHub Flow workflow](https://guides.github.com/introduction/flow/).
65
+
-**DO** follow the [GitHub Flow workflow](https://guides.github.com/introduction/flow/).
100
66
-**DO** blog and tweet (or whatever) about your contributions, frequently!
101
67
102
68
> [!NOTE]
103
-
> 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.
69
+
> 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.
104
70
105
71
## Building the docs
106
72
107
-
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](http://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/dotnet).
73
+
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](http://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/dotnet).
108
74
109
75
If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.
110
76
111
-
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
112
-
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.
113
-
If you are comfortable with other ways listed on the link above, feel free to use those.
77
+
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
78
+
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.
79
+
If you are comfortable with other ways listed on the link above, feel free to use those.
114
80
115
-
**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.
81
+
**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.
116
82
117
83
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:
118
84
119
85
```
120
86
docfx -t default --serve
121
87
```
122
-
88
+
123
89
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.
124
90
125
91
**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.
126
92
127
93
# Contributing to samples
128
94
129
-
For now, include required sample code as inline code blocks in your article. The repo has a codesnippets folder, but this is not ready for public contributions.
95
+
For now, include required sample code as inline code blocks in your article. The repo has a codesnippets folder, but this is not ready for public contributions.
Welcome! This repo contains source files for the work-in-progress Visual Studio 2017 RC technical documentation. The topics are published on the [Visual Studio documentation site](https://docs.microsoft.com/visualstudio).
4
+
5
+
The documentation for Visual Basic and Visual C# are located in a separate repo at [http://github.com/dotnet/core-docs](http://github.com/dotnet/core-docs), and the Visual C++ documentation is located in the repo located at [http://github.com/Microsoft/cpp-docs](http://github.com/Microsoft/cpp-docs).
6
+
7
+
## Contributing to the documentation
8
+
9
+
To contribute to this documentation, please see the [Contributing guide](CONTRIBUTING.md).
10
+
We welcome your contributions to help us improve the Visual Studio docs. All the articles in this repository use GitHub flavored markdown.
11
+
12
+
Several feature areas of Visual Studio have their own folders in this repo, such as **debugger** for topics on debugging, **ide** for topics on the Visual Studio interactive development environment (IDE), and so forth. The **/media** subfolder in each folder contains art files for the topics. The [Contributing guide](CONTRIBUTING.md) has more information.
13
+
14
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
0 commit comments