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

Approach for referencing conceptual docs #25530

Merged
merged 3 commits into from
Aug 20, 2021
Merged

Conversation

ajcvickers
Copy link
Member

Part of #17508

This is a proof-of-concept on how to do this to get team review on before I do the whole codebase. For the change-tracking namespace I ended up with these links:

    /// <seealso href="https://aka.ms/efcore-docs-value-comparers">Documentation for EF Core value comparers.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-cascading">Documentation for EF Core cascade deletes and deleting orphans.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-change-tracking">Documentation for EF Core change tracking.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-entity-entries">Documentation for accessing tracked entities in EF Core.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-debug-views">Documentation for EF Core debug views.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-track-graph">Documentation for tracking entities in EF Core.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-providers">Documentation for EF Core database providers.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-local-views">Documentation for local views of tracked entities in EF Core.</seealso>

Also, I think it's okay to reference multiple of these where appropriate. In particular, for cross-cutting features like debug views.

Aka links are not actually created yet.

@ajcvickers ajcvickers requested a review from a team August 15, 2021 20:11
@ajcvickers
Copy link
Member Author

@dotnet/efteam Would appreciate quick feedback on this before I do the whole codebase.

Copy link
Member

@roji roji left a comment

Choose a reason for hiding this comment

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

This looks perfect to me - except the doc system doesn't seem to render them :(

  • MS.Data.Sqlite already has some <seealso> links, but these unfortunately don't seem to be rendered by the doc system (compare this source with this rendered doc page). We should probably reach out to the docs team and see what's up with that.
  • Nit: for other doc elements we put a single padding space around the text - I've never been sure why we do that (and nobody else seems to, e.g. ASP.NET).
  • I'm still not sure about the value of the extra aka.ms indirection, given that we always maintain permanent redirections when moving pages. But no strong feelings here.

@ajcvickers
Copy link
Member Author

Thanks @roji. Agree we should reach out to the docs team, but we'll also need to come up with something that works before then. I was thinking of just adding links in the remarks section.

@roji
Copy link
Member

roji commented Aug 16, 2021

Agreed, that sounds like the next-best thing. <remarks> do get rendered by the doc system (e.g. OnModelCreating).

@ajcvickers ajcvickers changed the base branch from main to release/6.0 August 18, 2021 11:08
@ajcvickers ajcvickers requested a review from a team August 18, 2021 11:09
@ajcvickers
Copy link
Member Author

Updated with inline links.

@ajcvickers ajcvickers closed this Aug 18, 2021
@ajcvickers ajcvickers reopened this Aug 18, 2021
Copy link
Member

@roji roji left a comment

Choose a reason for hiding this comment

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

LGTM

Part of #17508

This is a proof-of-concept on how to do this to get team review on before I do the whole codebase. For the change-tracking namespace I ended up with these links:

```C#
    /// <seealso href="https://aka.ms/efcore-docs-value-comparers">Documentation for EF Core value comparers.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-cascading">Documentation for EF Core cascade deletes and deleting orphans.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-change-tracking">Documentation for EF Core change tracking.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-entity-entries">Documentation for accessing tracked entities in EF Core.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-debug-views">Documentation for EF Core debug views.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-track-graph">Documentation for tracking entities in EF Core.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-providers">Documentation for EF Core database providers.</seealso>
    /// <seealso href="https://aka.ms/efcore-docs-local-views">Documentation for local views of tracked entities in EF Core.</seealso>
```

Also, I think it's okay to reference multiple of these where appropriate. In particular, for cross-cutting features like debug views.

Aka links are not actually created yet.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants