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
Make getting started more obvious when reading docs #4648
Comments
I love the direction and trying to make this all better - here are some thoughts. I'm not sure a full quickstart page for each databases makes sense.. In the Cosmos case, obviously a different language warrants a completely different code sample (everything is different), but a simple quickstart for EF will like differ by only a single line across providers - UseSqlServer vs. UseNpgsql (of course as you get deeper there are many other differences, but probably not at the quickstart level). Maybe it's enough to just use tabs here? i.e. in the "build a console application", "build an ASP.NET Core ...", we could have a tab for each provider where we show the code to configure the provider? This would also allow us to integrate all providers into all tutorial pages (and avoid an explosion of pages where we need to show console for SQL Server, for Cosmos...). Another note is to think about the relationship between the above and the ASP.NET tutorials (e.g. this). |
This is true, but the point here is to draw people in by letting them see something that they connect with without clicking into docs to get there. So, the point is to make "Cosmos with EF Core" a top-level item that people will see.
These will be a link to the existing ASP.NET tutorial. For the tutorials we own, we can add tabs. |
Right, from a "marketing" point of view I can see that.
I guess I'm wondering more on the precise line between "EF tutorials including web" (living in our docs) and "Web tutorials including EF" (living in ASP.NET's). But anyway, not important. |
We have had lots of great conversations over the last couple of years on improving doc layout. I don't want to forget all that, but this is something we could potentially do that is low cost and will help people getting started.
I have been reading Cosmos docs, and I noticed this structure:
That is, at the top level there are "Quickstarts" "Tutorials". These break out for the potential dimensions--in Cosmos case, the platforms/languages. The tutorials are then about building different kinds of applications.
For us, I think it would be:
The text was updated successfully, but these errors were encountered: