-
Notifications
You must be signed in to change notification settings - Fork 119
Update REAMDE to reference Microsoft Learn #459
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
|
I think we should offer a slightly more explicit link to the docs like in the ASP.NET readme They have the same descriptive paragraph with a link at the end- but then they have a quick bullet list with some main doc urls. Even if it's just something like: The customer I have in mind is someone who's familiar with FM but wants to get to a specific feature- like variants. The paragraph isn't relevant to them and the current link seems like it's a part of the intro. |
Do you mean the How about this: we also add a |
|
I have a question in my mind: who will read this README? Newcomers who just find this feature management library or pro users who have been using the library and want to have a deeper understand of this repo? For the newcomers, we can write a simple example in the readme and give some links to the Microsoft Learn (we have plenty of quickstarts there). |
I would not duplicate that content here. It adds extra burden for maintenance. If we like, we can have something like this: Follow the quickstart guide to learn how to integrate feature flags from Azure App Configuration into your .NET applications. Check out the feature reference document for a full feature rundown. See the API reference for more information. or shorter version: Follow the quickstart for .NET feature flag integration. View the feature reference and API reference for further details. (The links are placeholders only) |
README.md
Outdated
| Click the following link to see the official documentation on how to use feature management: | ||
|
|
||
| Feature flags provide a way for .NET and ASP.NET Core applications to turn features on or off dynamically. Developers can use feature flags in simple use cases like conditional statements to more advanced scenarios like conditionally adding routes or MVC filters. Feature flags are built on top of the .NET Core configuration system. Any .NET Core configuration provider is capable of acting as the backbone for feature flags. | ||
| [***Official Documentation***](https://learn.microsoft.com/azure/azure-app-configuration/feature-management-dotnet-reference) |
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.
Why do we duplicate this link? You already have it down below.
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.
Good point. I didn't realize that the same link was in the "Get Started" section below. I don't think we should have both.
As to which one to keep, I don't like how the Get Started's feature reference link is embedded in a paragraph. I feel the navigation is easier when the link is stand alone and well named like the above example.
However, that could be said about all the links in Get Started. If it sounds reasonable one thing we could do is have no links in get started and instead enumerate the links afterwards like this.
Get started
Quickstart: A quickstart guide is available to learn how to integrate feature flags from Azure App Configuration into your .NET applications.
Feature reference: This document provides a full feature rundown.
API reference: This API reference details the API surface of this library.
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 like it.
README.md
Outdated
| * Routing | ||
| * Filters | ||
| * Action Attributes | ||
| [**API reference**](https://go.microsoft.com/fwlink/?linkid=2091700): This API reference details the API surface of this library. |
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.
We have more than one library. Something like this?
This API reference details the API surface of the libraries contained within this repository.
…-Dotnet into zhiyuanliang/update-readme
…soft/FeatureManagement-Dotnet into zhiyuanliang/update-readme
Why this PR?
The content of README has been migrated to the Microsoft Learn: https://learn.microsoft.com/en-us/azure/azure-app-configuration/feature-management-dotnet-reference?pivots=stable-version
The README in this repo should reference Microsoft Learn.