Skip to content

Port new triple slash docs for .NET 7 Alpha [? - Nov '21] #7424

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 32 commits into from
Dec 1, 2021

Conversation

carlossanlop
Copy link
Contributor

@carlossanlop carlossanlop commented Nov 24, 2021

No need to panic. I know it's a big PR but the majority of the changes are just EII messages in the remarks.

I split the changes in one commit per assembly to make it easier to review.

I'll try to submit monthly PRs to avoid having all the docs porting work right before we ship. cc @jeffhandley

Only 3 commits have actual new documentation, and need review from area owners:

System.Numerics - @tannergooding
System.Runtime.Intrinsics - @tannergooding
System.Text.Json - Largest chunk of actual new docs. - @layomia @eiriktsarpalis
System.Web - Largest commit, but it's mostly EII messages. - @Rick-Anderson

There are a few other assemblies with sprinkled individual docs.

@gewarren I also added the new docs the tool found in Microsoft.Build. Should I keep those? I kind of recall someone asking us not to modify their docs, but I can't find the issue/PR, or area owner.

@ghost ghost added the area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. label Nov 24, 2021
@carlossanlop carlossanlop self-assigned this Nov 24, 2021
@carlossanlop carlossanlop marked this pull request as ready for review November 24, 2021 18:17
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@opbld31

This comment has been minimized.

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding my comments on the MSBuild imports.

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
carlossanlop and others added 2 commits November 30, 2021 20:30
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@opbld33

This comment has been minimized.

@opbld33

This comment has been minimized.

@opbld31
Copy link

opbld31 commented Dec 1, 2021

Docs Build status updates of commit c239961:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/System.Web.UI.WebControls/ListView.xml ⚠️Warning View Details
xml/Microsoft.Build.Construction/ProjectElement.xml ✅Succeeded View
xml/Microsoft.Build.Framework/SdkReference.xml ✅Succeeded View
xml/Microsoft.Build.Globbing/CompositeGlob.xml ✅Succeeded View
xml/Microsoft.Build.Globbing/MSBuildGlob.xml ✅Succeeded View
xml/Microsoft.Build.Globbing/MSBuildGlobWithGaps.xml ✅Succeeded View
xml/Microsoft.Build.Graph/GraphBuildOptions.xml ✅Succeeded View
xml/Microsoft.Build.Logging/BinaryLogger.xml ✅Succeeded View
xml/Microsoft.Build.Logging/BuildEventArgsReader.xml ✅Succeeded View
xml/Microsoft.Build.Logging/ProfilerLogger.xml ✅Succeeded View
xml/Microsoft.Build.Tasks/CodeTaskFactory.xml ✅Succeeded View
xml/Microsoft.Build.Tasks/Copy.xml ✅Succeeded View
xml/Microsoft.Build.Tasks/DownloadFile.xml ✅Succeeded View
xml/Microsoft.Build.Tasks/RoslynCodeTaskFactory.xml ✅Succeeded View
xml/Microsoft.Build.Tasks/Unzip.xml ✅Succeeded View
xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml ✅Succeeded View
xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml ✅Succeeded View
xml/Microsoft.Extensions.Primitives/StringValues.xml ✅Succeeded View
xml/System.Activities.Presentation.Model/ModelItemCollection.xml ✅Succeeded View
xml/System.Activities.Presentation.Model/ModelItemDictionary.xml ✅Succeeded View
xml/System.Activities.Presentation.Model/ModelMemberCollection`2.xml ✅Succeeded View
xml/System.Activities.Presentation.PropertyEditing/PropertyEntryCollection.xml ✅Succeeded View
xml/System.Activities.Presentation.PropertyEditing/PropertyValueCollection.xml ✅Succeeded View
xml/System.Activities.Presentation/ContextItemManager.xml ✅Succeeded View
xml/System.Activities.Presentation/ServiceManager.xml ✅Succeeded View
xml/System.Activities/ExecutionProperties.xml ✅Succeeded View
xml/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml ✅Succeeded View
xml/System.ComponentModel.Design/DesignerCollection.xml ✅Succeeded View
xml/System.ComponentModel.Design/EventBindingService.xml ✅Succeeded View
xml/System.Device.Location/GeoCoordinateWatcher.xml ✅Succeeded View
xml/System.Dynamic/ExpandoObject.xml ✅Succeeded View
xml/System.IO.Compression/BrotliStream.xml ✅Succeeded View
xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml ✅Succeeded View
xml/System.Messaging/MessageEnumerator.xml ✅Succeeded View
xml/System.Messaging/MessageQueueEnumerator.xml ✅Succeeded View
xml/System.Numerics/Vector.xml ✅Succeeded View
xml/System.Numerics/Vector2.xml ✅Succeeded View
xml/System.Numerics/Vector3.xml ✅Succeeded View
xml/System.Numerics/Vector4.xml ✅Succeeded View
xml/System.Numerics/Vector`1.xml ✅Succeeded View
xml/System.Resources.Extensions/DeserializingResourceReader.xml ✅Succeeded View
xml/System.Resources/ResourceSet.xml ✅Succeeded View
xml/System.Security.Cryptography/AsymmetricAlgorithm.xml ✅Succeeded View
xml/System.Speech.Recognition/SemanticValue.xml ✅Succeeded View
xml/System.Text.Json.Serialization.Metadata/JsonCollectionInfoValues`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml ✅Succeeded View
xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml ✅Succeeded View
xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfoValues`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo.xml ✅Succeeded View

This comment lists only the first 50 files in the pull request.

xml/System.Web.UI.WebControls/ListView.xml

  • Line 0, Column 0: [Warning: xref-not-found] Cross reference not found: 'System.Web.WebSysDescriptionAttribute'.
  • Line 0, Column 0: [Warning: xref-not-found] Cross reference not found: 'System.Web.WebSysDescriptionAttribute'.
  • Line 0, Column 0: [Warning: xref-not-found] Cross reference not found: 'System.Web.WebSysDescriptionAttribute'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks perfect, thanks!

@carlossanlop carlossanlop merged commit 440ff0d into dotnet:main Dec 1, 2021
@carlossanlop carlossanlop deleted the Preview0 branch December 1, 2021 05:04
@carlossanlop carlossanlop changed the title Port new triple slash docs for .NET 7 (mostly EII) Port new triple slash docs for .NET 7 Alpha [? - Nov '21] Dec 16, 2021
@rzikm rzikm mentioned this pull request Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants