-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Remove legacy Type Provider content from ToC and update index #4852
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
Conversation
|
@dsyme would love a review here as well |
| ### [F# Interactive](fsharp/tutorials/fsharp-interactive/index.md) | ||
| ### [Type Providers](fsharp/tutorials/type-providers/index.md) | ||
| #### [Accessing a SQL Database by Using Type Providers](fsharp/tutorials/type-providers/accessing-a-sql-database.md) | ||
| #### [Accessing a SQL Database by Using Type Providers and Entities](fsharp/tutorials/type-providers/accessing-a-sql-database-entities.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what should happen to these topics that are out of the TOC now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm personally okay with deleting them, but there are probably some existing links out there which would break if they were deleted. If they're unlinked from the ToC, I would assume that this would give them less SEO weight. But if we still think they'll show up in searches, we should just delete them because they suggest using libraries which are out of date and unmaintained.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SEO is not based on whether they show up on the TOC or not, so I think you should remove them. Links out there should be redirected to whatever replacement you put for them here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
|
@Rickasaurus FYI if you had any suggestions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs to fix the redirect url before merging. Also left a couple of nits to be fixed if you'd like.
.openpublishing.redirection.json
Outdated
| }, | ||
| { | ||
| "source_path": "docs/fsharp/tutorials/type-providers/accessing-a-sql-database-entities.md", | ||
| "redirect_url": "docs/fsharp/tutorials/type-providers/index.md" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no .md in the redirect url
| Type Providers come in two forms: Generative and Erased. | ||
|
|
||
| Where necessary, you can create your own custom type providers, or reference type providers that have been created by others. For example, assume your organization has a data service providing a large and growing number of named data sets, each with its own stable data schema. You may choose to create a type provider that reads the schemas and presents the latest available data sets to the programmer in a strongly typed way. | ||
| Generative Type Providers produce types which can be written as .NET types into the assembly in which they are produced. This allows them to be consumed from code in other assemblies. This means that the typed representation of the data source must generally be one which is feasible to represent with .NET types. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: types which -> types that
one which -> one that
| Where necessary, you can create your own custom type providers, or reference type providers that have been created by others. For example, assume your organization has a data service providing a large and growing number of named data sets, each with its own stable data schema. You may choose to create a type provider that reads the schemas and presents the latest available data sets to the programmer in a strongly typed way. | ||
| Generative Type Providers produce types which can be written as .NET types into the assembly in which they are produced. This allows them to be consumed from code in other assemblies. This means that the typed representation of the data source must generally be one which is feasible to represent with .NET types. | ||
|
|
||
| Erasing Type Providers produce types which can only be consumed in the assembly or project they are generated from. The types are ephemeral; that is, they are not written into an assembly and cannot be consumed by code in other assemblies. They can contain *delayed* members, allowing you to use provided types from a potentially infinite information space. They are useful for using a small subset of a large and interconnected data source. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: types which -> types that
| |[Tutorial: Creating a Type Provider](creating-a-type-provider.md)|Provides information on writing your own custom type providers.| | ||
| |[Type Provider Security](type-provider-security.md)|Provides information about security considerations when developing type providers.| | ||
| |[Troubleshooting Type Providers](troubleshooting-type-providers.md)|Provides information about common problems that can arise when working with type providers and includes suggestions for solutions.| | ||
| - [FSharp.Data](https://fsharp.github.io/FSharp.Data/) includes Type Providers for JSON, XML, CSV and HTML document formats. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: add comma after CSV (oxford comma)
Addresses #4810. I haven't quite locked down on descriptions and the set of common Type Providers folks should take a look at yet.