Skip to content

Conversation

@zhiyuanliang-ms
Copy link
Member

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.

@rossgrambo
Copy link
Member

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.

@zhiyuanliang-ms
Copy link
Member Author

@rossgrambo

they have a quick bullet list with some main doc urls. Even if it's just something like:

Do you mean the Get started section in the ASP.NET readme

How about this: we also add a Get started section in our readme. We will list the following topics:
Concepts: https://learn.microsoft.com/en-us/azure/azure-app-configuration/concept-feature-management (This page needs to be updated. It should reference the new .NET feature management page)
feature flag configuration: https://learn.microsoft.com/en-us/azure/azure-app-configuration/feature-management-dotnet-reference?pivots=stable-version#feature-flag-configuration
How to use feature management: https://learn.microsoft.com/en-us/azure/azure-app-configuration/feature-management-dotnet-reference?pivots=stable-version#consumption

@zhiyuanliang-ms
Copy link
Member Author

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).
For the pro users, I think a detailed index will be helpful. How about keep the original index section here:

## Index
* [Feature Flags](#feature-flags)
    * [Feature Filters](#feature-filters)
    * [Feature Flag Declaration](#feature-flag-declaration)
* [Consumption](#consumption)
* [ASP.NET Core Integration](#ASPNET-core-integration)
* [Implement a Feature Filter](#implementing-a-feature-filter)
* [Providing a Context For Feature Evaluation](#providing-a-context-for-feature-evaluation)
* [Built-in Feature Filters](#built-in-feature-filters)
* [Targeting](#targeting)
  * [Targeting Exclusion](#targeting-exclusion)
* [Caching](#caching)
* [Custom Feature Providers](#custom-feature-providers)

@zhenlan
Copy link
Member

zhenlan commented Jun 6, 2024

How about keep the original index section here

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)
Copy link
Member

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.

Copy link
Member

@jimmyca15 jimmyca15 Jun 13, 2024

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.

Copy link
Member

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.
Copy link
Member

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.

@zhiyuanliang-ms zhiyuanliang-ms merged commit f88aec9 into main Jun 15, 2024
@zhiyuanliang-ms zhiyuanliang-ms deleted the zhiyuanliang/update-readme branch June 15, 2024 12:34
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.

5 participants