EntityFramework.ApiDocs icon indicating copy to clipboard operation
EntityFramework.ApiDocs copied to clipboard

Move EF6, EF5, and EF4.3.1 API reference to Docs

Open divega opened this issue 7 years ago • 7 comments
trafficstars

The API references for the non-core versions of the NuGet package should be part of the .NET API Browser. I talked to @dend and apparently they can be hosted in this repo.

To have complete coverage we discussed having the API reference generated for the following EntityFramework package versions:

  • https://www.nuget.org/packages/EntityFramework/6.2.0
  • https://www.nuget.org/packages/EntityFramework/5.0.0
  • https://www.nuget.org/packages/EntityFramework/4.3.1

Current locations which need to be redirected

  • EF6

    • https://msdn.microsoft.com/library/dn223258(v=vs.113).aspx (our conceptual docs point here)
    • https://msdn.microsoft.com/en-us/library/mt154346(v=vs.113).aspx (duplicate)
  • EF5

    • https://msdn.microsoft.com/en-us/library/hh289362(v=vs.103).aspx

divega avatar Aug 02 '18 18:08 divega

@sudeepku you can close this issue as fixed once you finish with publishing the new API docs and the redirects.

Also, remember to let me know when it is done so I can update the links in our conceptual doc pages.

divega avatar Nov 12 '18 18:11 divega

The API reference of EF 6 at https://docs.microsoft.com/en-us/dotnet/api/?view=entity-framework-6.2.0, but other versions are still empty:

https://docs.microsoft.com/en-us/dotnet/api/?view=entity-framework-5.0.0

https://docs.microsoft.com/en-us/dotnet/api/?view=entity-framework-4.3.1

Also the redirects on the old API references on MSDN are still needed.

cc @dend @Sampy @sudeepku

divega avatar Nov 29 '18 23:11 divega

@dendeli-msft @sudeepku @Sampy, FYI, EF 5.0.0 and 4.3.1 APIs are still missing in the API browser.

divega avatar Dec 10 '18 21:12 divega

Looking at the contents of the live branch, I don't see any files in the FrameworksIndex folder for any version other than 6. You can see this on docs itself if you go to a page for entity framework and try to change the version for example: https://docs.microsoft.com/en-us/dotnet/api/system.data.entity?view=entity-framework-6.2.0. Unless System.Data.Entity is only defined in 6.2.0 and I picked a bad page, this means no part of docs knows about any version other than 6.2.0 since this repo doesn't define documentation for those versions.

The problem is deeper than the API Browser not showing them. Docs currently only has pages for the 6.2.0 release it seems.

Sampy avatar Dec 10 '18 22:12 Sampy

I only see 6.2 in the FrameworksIndex folder as well: https://github.com/aspnet/EntityFramework.ApiDocs/tree/live/EF/xml/FrameworksIndex

Probably the other monikers shouldn't be live until the content is there.

mairaw avatar Dec 19 '18 02:12 mairaw

Tagging @ajcvickers

We have docs for EF 6.2/5.0/4.3.1 & SqlCompact for 6.2 only. (files here https://github.com/aspnet/EntityFramework.ApiDocs/tree/live/EF/xml/FrameworksIndex)

From

Current locations which need to be redirected EF6 https://msdn.microsoft.com/library/dn223258(v=vs.113).aspx (our conceptual docs point here) https://msdn.microsoft.com/en-us/library/mt154346(v=vs.113).aspx (duplicate) EF5 https://msdn.microsoft.com/en-us/library/hh289362(v=vs.103).aspx

First link is 404. 2nd redirects correctly 3rd still points to MSDN docs.

Also should we publish docs for EF 6.3?

smitpatel avatar Oct 07 '19 23:10 smitpatel

What are the targets for 1st and 3rd? I can work with you offline with the team that is handling redirections.

mairaw avatar Oct 08 '19 00:10 mairaw