Skip to content

Repo sync for protected CLA branch #4126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Thank you for your interest in contributing to the Visual C++ documentation!

In this topic, you'll see the basic process for adding or updating content in the [Visual C++ documentation site](https://docs.microsoft.com/cpp).
In this topic, you'll see the basic process for adding or updating content in the [Visual C++ documentation site](https://docs.microsoft.com/cpp/).

In this topic, we'll cover:

Expand Down Expand Up @@ -44,17 +44,17 @@ docs
wstring-conversion.png
```

**Step 5:** Submit a Pull Request (PR) from your branch to `MicrosoftDocs/cpp-docs/master`.
**Step 5:** Submit a Pull Request (PR) from your branch to `MicrosoftDocs/cpp-docs/main`.

If your PR is addressing an existing issue, add the `Fixes #Issue_Number` keyword to the commit message or PR description, so the issue can be automatically closed when the PR is merged. For more information, see [Closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/).

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.

**Step 6:** Make any necessary updates to your branch as discussed with the team.

The maintainers will merge your PR into the master branch once feedback has been applied and your change looks good.
The maintainers will merge your PR into the main branch once feedback has been applied and your change looks good.

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 on [docs.microsoft.com](https://docs.microsoft.com/cpp/).
On a certain cadence, we push all commits from main branch into the live branch and then you'll be able to see your contribution on [Microsoft Docs](https://docs.microsoft.com/cpp/).

## DOs and DON'Ts

Expand All @@ -72,7 +72,7 @@ Below is a short list of guiding rules that you should keep in mind when you are

## Building the docs

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/).
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 and build tools. It's published on [Microsoft Docs](https://docs.microsoft.com/).

If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.

Expand All @@ -94,6 +94,6 @@ For now, include required sample code as inline code blocks in your article. The

## Contributor license agreement

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 Uncyclopedia.
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects on Microsoft Docs. You can read more about [Contribution License Agreements (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Uncyclopedia.

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.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The documentation for Visual Basic and Visual C# are located in a separate repos

## Contributing to the documentation

We welcome your contributions to help us improve the MSVC docs. For a comprehensive guide to contributing to docs.microsoft.com, see the [Microsoft Docs contributor guide overview](https://docs.microsoft.com/contribute). For details on how to make a contribution to the MSVC documentation, see the [Contributing guide](CONTRIBUTING.md).
We welcome your contributions to help us improve the MSVC docs. For a comprehensive guide to contributing to Microsoft Docs, see the [contributor guide overview](https://docs.microsoft.com/contribute). For details on how to make a contribution to the MSVC documentation, see the [Contributing guide](CONTRIBUTING.md).

Several feature areas of MSVC have their own folders in this repository, such as `standard-library` for articles on the C++ Standard Library, `ide` for C++-specific articles on the Visual Studio interactive development environment (IDE), and so forth. The `/media` subfolder in each folder contains art files for the articles. The [Contributing guide](CONTRIBUTING.md) has more information.

Expand Down
2 changes: 1 addition & 1 deletion docs/build/building-on-the-command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ Use the compiler (cl.exe) to compile and link source code files into apps, libra
[`Link`](reference/linking.md)<br/>
Use the linker (link.exe) to link compiled object files and libraries into apps and DLLs.

When you build on the command line, the F1 command isn't available for instant help. Instead, you can use a search engine to get information about warnings, errors, and messages. You can also download and use the offline help files. To use the search in docs.microsoft.com, enter your query in the search box at the top of any article.
When you build on the command line, the F1 command isn't available for instant help. Instead, you can use a search engine to get information about warnings, errors, and messages. You can also download and use the offline help files. To use the search in Microsoft Docs, enter your query in the search box at the top of any article.

## Command-line project management tools

Expand Down
2 changes: 1 addition & 1 deletion docs/ide/adding-functionality-with-code-wizards-cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.assetid: 6afb7ef9-7056-423d-b244-91bb4236d1d7
Once you have created a project, you will want to change or add to that project's functionality. Such tasks include creating new classes, adding new member functions and variables, and adding Automation methods and properties. The code wizards are designed to let you do all these things.

> [!NOTE]
> The following rarely-used code wizards are removed in Visual Studio 2019. General support for ATL and MFC is not impacted by the removal of these wizards. Sample code for these technologies is archived at Microsoft Docs and the VCSamples GitHub repository.
> The following rarely-used code wizards are removed in Visual Studio 2019. General support for ATL and MFC is not impacted by the removal of these wizards. Sample code for these technologies is archived in Microsoft Docs and the VCSamples GitHub repository.

- ATL COM+ 1.0 Component Wizard
- ATL Active Server Pages Component Wizard
Expand Down
2 changes: 1 addition & 1 deletion docs/ide/read-and-understand-code-cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Hover over a variable or function declaration, right-click, then choose **Peek D

## F1 Help

Place the cursor on or just after any type, keyword or function and press **F1** to go directly to the relevant reference topic on docs.microsoft.com. **F1** also works on items in the error list, and in many dialog boxes.
Place the cursor on or just after any type, keyword or function and press **F1** to go directly to the relevant reference topic on Microsoft Docs. **F1** also works on items in the error list and in many dialog boxes.

## Class View

Expand Down
10 changes: 5 additions & 5 deletions docs/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -127,19 +127,19 @@ tools:
title: Languages and frameworks
items:
- title: C++
imageSrc: https://docs.microsoft.com/media/logos/logo_Cplusplus.svg
imageSrc: /media/logos/logo_Cplusplus.svg
url: cpp/index.yml
- title: C
imageSrc: https://docs.microsoft.com/media/logos/logo_C.svg
imageSrc: /media/logos/logo_C.svg
url: c-language/index.yml
- title: Microsoft Assembler
imageSrc: media/index/logo-asm.svg
url: intrinsics/index.yml
- title: C++/CX for Windows Runtime
imageSrc: https://docs.microsoft.com/media/logos/logo_Cplusplus.svg
imageSrc: /media/logos/logo_Cplusplus.svg
url: cppcx/visual-c-language-reference-c-cx.md
- title: C++/CLI for .NET
imageSrc: https://docs.microsoft.com/media/logos/logo_Cplusplus.svg
imageSrc: /media/logos/logo_Cplusplus.svg
url: dotnet/dotnet-programming-with-cpp-cli-visual-cpp.md
- title: Active Template Library (ATL)
imageSrc: media/index/logo-atl.svg
Expand All @@ -148,7 +148,7 @@ tools:
imageSrc: media/index/logo-mfc.svg
url: mfc/mfc-desktop-applications.md
- title: C++/WinRT for Windows Runtime
imageSrc: https://docs.microsoft.com/media/logos/logo_Cplusplus.svg
imageSrc: /media/logos/logo_Cplusplus.svg
url: /windows/uwp/cpp-and-winrt-apis/

# additionalContent section (optional)
Expand Down
2 changes: 1 addition & 1 deletion docs/mfc/ole-background.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Some of the more important OLE topics are covered in the following articles:

- [OLE Background: MFC Implementation](ole-background-mfc-implementation.md)

For general OLE information not found in the above articles, [search for OLE](/search/?terms=ole) in Microsoft Docs.
For general OLE information not found in the articles listed, [search for OLE](/search/?terms=ole) .

## See also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ Create your repro as a minimal IDE project, then package it by compressing the e

## Ways to send your report

You have a couple of good ways to get your report to us. You can use Visual Studio's built-in [Report a Problem Tool](/visualstudio/ide/how-to-report-a-problem-with-visual-studio), or the [Visual Studio Developer Community]( https://aka.ms/feedback/report?space=62) page. There's also a **Product feedback** button at the bottom of this page. The choice depends on whether you want to use the built-in tools in the IDE to capture screenshots and organize your report. If you prefer not to, you can use the Developer Community website directly.
You have a couple of good ways to get your report to us. You can use Visual Studio's built-in [problem reporting tool](/visualstudio/ide/how-to-report-a-problem-with-visual-studio) or the [Visual Studio Developer Community](https://aka.ms/feedback/report?space=62) page. There's also a **Product feedback** button at the bottom of this page. The choice depends on whether you want to use the built-in tools in the IDE to capture screenshots and organize your report. If you prefer not to, you can use the Developer Community website directly.

> [!NOTE]
> Regardless of how you submit your report, Microsoft respects your privacy. Microsoft is committed to compliance with all data privacy laws and regulations. For information about how we treat the data that you send us, see the [Microsoft Privacy Statement](https://privacy.microsoft.com/privacystatement).
Expand Down Expand Up @@ -404,6 +404,6 @@ To maintain your privacy and keep your sensitive information out of public view,

## How to report a C++ documentation issue

We use GitHub issues to track problems reported in our documentation. You can now create GitHub issues directly from a content page, which enables you interact in a much richer way with writers and product teams. If you see an issue with a document, a bad code sample, a confusing explanation, a critical omission, or even just a typo, you can easily let us know. Scroll to the bottom of the page and select **Sign in to give documentation feedback**. You'll need to create a GitHub account if you don't have one already. When you have a GitHub account, you can see all of our documentation issues and their status. You also get notifications when changes are made for the issue you reported. For more information, see [A New Feedback System Is Coming to docs.microsoft.com](/teamblog/a-new-feedback-system-is-coming-to-docs).
We use GitHub issues to track problems reported in our documentation. You can now create GitHub issues directly from a content page, which enables you interact in a much richer way with writers and product teams. If you see an issue with a document, a bad code sample, a confusing explanation, a critical omission, or even just a typo, you can easily let us know. Scroll to the bottom of the page and select **Sign in to give documentation feedback**. You'll need to create a GitHub account if you don't have one already. When you have a GitHub account, you can see all of our documentation issues and their status. You also get notifications when changes are made for the issue you reported. For more information, see our [Feedback System blog entry](/teamblog/a-new-feedback-system-is-coming-to-docs).

You create a documentation issue on GitHub when you use the documentation feedback button. The issue is automatically filled in with some information about the page you created the issue on. That's how we know where the problem is located, so don't edit this information. Just append the details about what's wrong, and if you like, a suggested fix. [Our C++ docs are open source](https://github.com/MicrosoftDocs/cpp-docs/), so if you'd like to submit a fix yourself, you can. For more information about how you can contribute to our documentation, see our [Contributing guide](https://github.com/MicrosoftDocs/cpp-docs/blob/master/CONTRIBUTING.md) on GitHub.
2 changes: 1 addition & 1 deletion docs/overview/visual-cpp-help-and-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You can view Microsoft developer content online. This content is updated regular

You can also download and view the content locally in the offline Help Viewer. The offline documentation is organized by books of related content, which are also updated periodically. You can download the books you're interested in as they become available. For more information, see [Microsoft Help Viewer](/visualstudio/ide/microsoft-help-viewer).

Many sections of the documentation are also available in PDF form. These sections have a **Download PDF** link below the table of contents on docs.microsoft.com.
Many sections of the documentation are also available in PDF form. These sections have a **Download PDF** link below the table of contents on Microsoft Docs.

## Related sites

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/visual-cpp-samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ms.assetid: 76798022-5886-48e7-a7f2-f99352b15cbf

Samples for Visual Studio C++ are available on the web. Microsoft has produced many C++ samples that demonstrate different functionalities across multiple technologies. Here are a few of the places to find additional samples:

- [Microsoft Docs samples - C++](/samples/browse/?term=c%2B%2B)
- [C++ code samples](/samples/browse/?term=c%2B%2B)

- [Windows samples on GitHub](https://microsoft.github.io/windows/)

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/what-s-new-for-cpp-2019.md
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ IncrediBuild is included as an optional component in the **Desktop development w
- MFC class from ActiveX control
- MFC class from Type Lib.

Sample code for these technologies is archived at Microsoft Docs and the VCSamples GitHub repository.
Sample code for these technologies is archived in Microsoft Docs and the VCSamples GitHub repository.

- The Windows 8.1 Software Development Kit (SDK) is no longer available in the Visual Studio installer. We recommend you upgrade your C++ projects to the latest Windows SDK. If you have a hard dependency on 8.1, you can download it from the Windows SDK archive.

Expand Down
6 changes: 3 additions & 3 deletions docs/overview/whats-new-cpp-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,8 @@ This article lists major changes to the Microsoft C++ docs July 2021 through Oct

## Community contributors

The following people contributed to the C++, C, and Assembler docs during this period. Thank you! See [Microsoft Docs contributor guide overview](/contribute/) if you'd like to learn how to contribute.

The following people contributed to the C++, C, and Assembler docs during this period. Thank you! See our [contributor guide overview](/contribute/) if you'd like to learn how to contribute.
s
- [mohammad-ghasemi-dev](https://github.com/mohammad-ghasemi-dev) (5)
- [Jaiganeshkumaran](https://github.com/Jaiganeshkumaran) - Jaiganesh Kumaran (2)
- [workingjubilee](https://github.com/workingjubilee) - Jubilee (2)
Expand Down Expand Up @@ -546,7 +546,7 @@ Many articles were updated to prevent the machine translation of code elements.

#### Community contributors

The following people contributed to the C++, C, and Assembler docs during this period. Thank you! See [Microsoft Docs contributor guide overview](/contribute/) if you'd like to learn how to contribute.
The following people contributed to the C++, C, and Assembler docs during this period. Thank you! See our [contributor guide overview](/contribute/) if you'd like to learn how to contribute.

- [0xbadfca11](https://github.com/0xbadfca11) (1)
- [bclehmann](https://github.com/bclehmann) - Benjamin Lehmann (1)
Expand Down