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
{{ message }}
Repository navigation
Commit 656350e
Browse filesBrowse the repository at this point in the historyBrowse files
@@ -19,7 +19,7 @@ The content inside the **docs** folder is organized into sections that are organ
19
19
20
20
You can skip this first step for small changes.
21
21
22
-
**Step 2:** Fork the `MicrosoftDocs/cpp-docs`repo.
22
+
**Step 2:** Fork the `MicrosoftDocs/cpp-docs`repository.
23
23
24
24
**Step 3:** Create a `branch` for your article.
25
25
@@ -30,17 +30,17 @@ If it's a new topic, you can use this [template file](./styleguide/template.md)
30
30
Navigate to the folder that corresponds to the TOC location determined for your article in step 1.
31
31
That folder contains the Markdown files for all articles in that section. If necessary, create a new folder to place the files for your content.
32
32
33
-
For images and other static resources, add them to the subfolder called **media**. If you are creating a new folder for content, add a media folder to the new folder.
33
+
For images and other static resources, add them to the subfolder called `media`. If you are creating a new folder for content, add a media folder to the new folder.
34
34
35
35
Be sure to follow the proper Markdown syntax. See the [style guide](./styleguide/template.md) for more information.
36
36
37
37
### Example structure
38
38
39
39
docs
40
-
/standard-library
41
-
wstring-convert-class.md
42
-
/media
43
-
wstring-conversion.png
40
+
/standard-library
41
+
wstring-convert-class.md
42
+
/media
43
+
wstring-conversion.png
44
44
45
45
**Step 5:** Submit a Pull Request (PR) from your branch to `MicrosoftDocs/cpp-docs/master`.
46
46
@@ -70,30 +70,28 @@ Below is a short list of guiding rules that you should keep in mind when you are
70
70
71
71
## Building the docs
72
72
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/).
73
+
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](https://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/).
74
74
75
75
If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.
76
76
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.
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). 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.
80
78
81
79
**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.
82
80
83
81
You can build and preview the resulting site locally using a built-in web server. Navigate to the `cpp-docs\docs` folder on your machine and type the following command:
84
82
85
-
`docfx -t default --serve`
83
+
> docfx -t default --serve
86
84
87
85
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/cpp/visual-cpp-in-visual-studio.html`.
88
86
89
87
**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. We also use some custom extensions for embedded video, notes, and included documents, that won't be visible in the preview.
90
88
91
89
## Contributing to samples
92
90
93
-
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.
91
+
For now, include required sample code as inline code blocks in your article. The repository has a `codesnippets` folder, but this is not ready for public contributions.
94
92
95
93
## Contributor license agreement
96
94
97
-
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia.
95
+
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia.
98
96
99
-
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with cla-not-required. Otherwise, it's classified as cla-required. Once you signed the CLA, the current and all future pull requests are labeled as cla-signed.
97
+
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with CLA-not-required. Otherwise, it's classified as CLA-required. Once you signed the CLA, the current and all future pull requests are labeled as CLA-signed.
0 commit comments