Skip to content
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

feat: compute mslearn symbol URL #8546

Merged
merged 6 commits into from
Mar 24, 2023
Merged

feat: compute mslearn symbol URL #8546

merged 6 commits into from
Mar 24, 2023

Conversation

yufeih
Copy link
Contributor

@yufeih yufeih commented Mar 23, 2023

The xref service was introduced to provide fast query by uid with a database backend. Microsoft Learn today still maintains and hosts an xref service for the .NET BCL, it is only used by the open-source community today and may be retired in the future.

There are also limitations of using xrefmap as intermediary in resolving .NET API cross references, e.g., missing info in xrefmaps causes <inheritdoc /> problems. We’d like to move to a future where API references are resolved directly based on Symbols, both the content and URLs.

URLs can be resolved based on conventions. This first step decouples docfx from mslearn xref service by matching assembly names against a list of assemblies published to mslearn and resolving them based on mslearn URL convention.

#8567 #5053 #3597

@yufeih yufeih added the new-feature Makes the pull request to appear in "New Features" section of the next release note label Mar 23, 2023
@yufeih yufeih force-pushed the symbolurl-mslearn branch from 2cee4e3 to ad78f63 Compare March 23, 2023 12:07
@paulushub
Copy link

Is there a way or API to link to articles (conceptual topics) in the Microsoft Learn Docs?

@yufeih yufeih force-pushed the symbolurl-mslearn branch from ad78f63 to 2c0a4bc Compare March 23, 2023 12:13
@yufeih
Copy link
Contributor Author

yufeih commented Mar 23, 2023

Is there a way or API to link to articles (conceptual topics) in the Microsoft Learn Docs?

No at the moment. URL is the way for external site to link to MSLearn docs, most high traffic pages would setup redirection on URL change.

@codecov
Copy link

codecov bot commented Mar 23, 2023

Codecov Report

Patch coverage: 96.90% and project coverage change: +0.06 🎉

Comparison is base (9ff9823) 75.15% compared to head (7979abf) 75.21%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8546      +/-   ##
==========================================
+ Coverage   75.15%   75.21%   +0.06%     
==========================================
  Files         643      645       +2     
  Lines       23558    23637      +79     
==========================================
+ Hits        17704    17779      +75     
- Misses       5854     5858       +4     
Impacted Files Coverage Δ
...ft.DocAsCode.Dotnet/Visitors/YamlModelGenerator.cs 97.80% <ø> (-0.08%) ⬇️
...de.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs 75.47% <88.88%> (ø)
...soft.DocAsCode.Dotnet/SymbolUrlResolver.MSLearn.cs 97.01% <97.01%> (ø)
...osoft.DocAsCode.Dotnet/Filters/ConfigFilterRule.cs 88.88% <100.00%> (ø)
....DocAsCode.Dotnet/Parsers/XmlCommentTransformer.cs 100.00% <100.00%> (ø)
src/Microsoft.DocAsCode.Dotnet/SymbolFormatter.cs 100.00% <100.00%> (ø)
src/Microsoft.DocAsCode.Dotnet/SymbolHelper.cs 96.96% <100.00%> (+0.19%) ⬆️
...rc/Microsoft.DocAsCode.Dotnet/SymbolUrlResolver.cs 100.00% <100.00%> (ø)
....DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs 94.69% <100.00%> (+0.14%) ⬆️

... and 4 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@yufeih yufeih closed this Mar 24, 2023
@yufeih yufeih reopened this Mar 24, 2023
@yufeih yufeih marked this pull request as ready for review March 24, 2023 09:48
@yufeih yufeih merged commit 52e3455 into main Mar 24, 2023
@yufeih yufeih deleted the symbolurl-mslearn branch March 24, 2023 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature Makes the pull request to appear in "New Features" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants