Update repo documents #3

linglingye001 · 2025-03-07T03:33:40Z

No description provided.

Copilot

Pull Request Overview

This PR updates the repository documentation by revising the support instructions and enhancing the README with a clearer project title, installation instructions, and examples.

Removed outdated template text from SUPPORT.md and added a direct link for issue submission.
Updated README.md with a more descriptive project title, installation command, and concrete examples.

Reviewed Changes

Copilot reviewed 2 out of 4 changed files in this pull request and generated no comments.

File	Description
SUPPORT.md	Removed placeholder instructions and added updated support information and link.
README.md	Revised project title, added installation instructions, and example sections.

Files not reviewed (2)

LICENSE: Language not supported
NOTICE: Language not supported

Comments suppressed due to low confidence (2)

SUPPORT.md:9

The issues link references https://github.com/Azure/AppConfiguration/issues, which may not align with the current repository for the Go Provider. Consider updating it to the correct GitHub Issues URL if applicable.

You can also open [issues](https://github.com/Azure/AppConfiguration/issues) to ask questions or share feedback about Azure App Configuration.

README.md:1

[nitpick] Please verify that the updated project title accurately reflects the repository's scope and naming consistency, especially in relation to other references in the documentation.

# Azure App Configuration - Go Provider

zhenlan · 2025-03-31T15:46:04Z

README.md


-> This repo has been populated by an initial template to help get you started. Please
-> make sure to update the content to build a great experience for community-building.
+[Azure App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/overview) is a managed service that helps developers centralize their application configurations simply and securely. Go provider adds additional functionalities above the [Azure SDK for Go](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/data/azappconfig), which enables loading configuration from an Azure App Configuration store in a managed way. 


I know we copied this from the JS provider, but it gives me no idea what the go provider is about and why someone should use it. Can we rewrite?

Sorry for this, I updated the README to list supported features in v1.0.0-beta.1. This README will be continuously updated as new features are added and the quickstart docs available. Currently the go provider v1.0.0-beta.1 is ready to go public and release before this PR merged, can you help to review this PR? Thanks

README.md

RichardChen820 · 2025-04-01T07:10:54Z

README.md

+- **Hierarchical Configuration**: Convert flat key-value pairs into nested configuration objects using customizable separators 
+- **Key Filtering and Prefix Management**: Selectively load configuration and remove prefixes for cleaner code
+- **Automatic Key Vault Integration**: Transparently resolve Key Vault references as part of the configuration loading process
+- **JSON Content Support**: Automatic parsing of JSON values into native Go types


Not sure what's this refers to?

json content type key values

I see, have we mentioned this feature in other providers, if not, I think we can just remove it.

RichardChen820 · 2025-04-07T13:12:21Z

README.md

+
+The repository includes complete examples showing how to use the Go Provider in different scenarios:
+
+- [Console Application](./example/console-example/): Simple CLI app using App Configuration


Simple console app with Azure App Configuration integration

RichardChen820 · 2025-04-07T13:12:34Z

README.md

+The repository includes complete examples showing how to use the Go Provider in different scenarios:
+
+- [Console Application](./example/console-example/): Simple CLI app using App Configuration
+- [Web Application](./example/gin-example/): Gin web app with App Configuration integration


Gin web app with Azure App Configuration integration

zhenlan · 2025-04-09T07:43:34Z

README.md

+
+## Examples
+
+The repository includes complete examples showing how to use the Go Provider in different scenarios:


Remove. (This is by no means "complete" examples :))

zhenlan · 2025-04-09T08:50:30Z

README.md

+
+## Examples
+
+- [Console Application](./example/console-example/): Simple console app with Azure App Configuration integration


Load settings from Azure App Configuration and use in a console application.

zhenlan · 2025-04-09T08:50:45Z

README.md

+## Examples
+
+- [Console Application](./example/console-example/): Simple console app with Azure App Configuration integration
+- [Web Application](./example/gin-example/): Gin web app with Azure App Configuration integration


Load settings from Azure App Configuration and use in a Gin web application.

zhenlan · 2025-04-09T09:41:07Z

README.md

- Updating SUPPORT.MD with content about this project's support experience
- Understanding the security reporting process in SECURITY.MD
- Remove this section from the README
+Azure App Configuration Go Provider is a client library that simplifies using [Azure App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/overview) in Go applications. It provides a high-level abstraction over the [Azure SDK for Go](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/data/azappconfig) that makes managing application settings easier and more intuitive.


The abstraction sounds odd. Suggest below:

Azure App Configuration provides centralized configuration storage and management, allowing users to update their configurations without the need to rebuild and redeploy their applications. The App Configuration provider for Go is built on top of the Azure Go SDK and is designed to simplify data consumption in App Configuration with rich features. Users can consume App Configuration key-values as strongly-typed structs with data binding or load them into popular third-party configuration libraries, minimizing code changes. The Go provider offers features such as configuration composition from multiple labels, key prefix trimming, automatic resolution of Key Vault references, feature flags, failover with geo-replication for enhanced reliability, and many more.

zhenlan · 2025-04-09T09:41:35Z

README.md

- Remove this section from the README
+Azure App Configuration Go Provider is a client library that simplifies using [Azure App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/overview) in Go applications. It provides a high-level abstraction over the [Azure SDK for Go](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/data/azappconfig) that makes managing application settings easier and more intuitive.
+
+## Features


Remove (covered in overview).

zhenlan · 2025-04-09T23:19:54Z

README.md

- Updating SUPPORT.MD with content about this project's support experience
- Understanding the security reporting process in SECURITY.MD
- Remove this section from the README
+[Azure App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/overview) provides centralized configuration storage and management, allowing users to update their configurations without the need to rebuild and redeploy their applications. The App Configuration provider for Go is built on top of the [Azure Go SDK](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/data/azappconfig) and is designed to simplify data consumption in App Configuration with rich features. Users can consume App Configuration key-values as strongly-typed structs with data binding or load them into popular third-party configuration libraries, minimizing code changes. The Go provider offers features such as configuration composition from multiple labels, key prefix trimming, automatic resolution of Key Vault references, feature flags, failover with geo-replication for enhanced reliability, and many more.


Drop /en-us from the link: https://docs.microsoft.com/azure/azure-app-configuration/overview

RichardChen820 changed the title ~~Update repo templates~~ Update repo documents Mar 21, 2025

linglingye001 added 4 commits March 31, 2025 10:17

update support.md

a094009

update

df66791

add notice

7a0fd22

add examples

f39c82c

linglingye001 force-pushed the linglingye/updateBoilerplates branch from 20e1649 to f39c82c Compare March 31, 2025 02:28

linglingye001 changed the base branch from main to release/v0 March 31, 2025 02:33

linglingye001 requested review from RichardChen820 and Copilot March 31, 2025 02:34

Copilot AI reviewed Mar 31, 2025

View reviewed changes

zhenlan reviewed Mar 31, 2025

View reviewed changes

update README

7b12346

RichardChen820 reviewed Apr 1, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

RichardChen820 reviewed Apr 1, 2025

View reviewed changes

linglingye001 added 4 commits April 1, 2025 16:11

update options

9bac284

revert

b077568

update

4903b17

update

446db38

RichardChen820 reviewed Apr 7, 2025

View reviewed changes

update README

76e8b87

RichardChen820 approved these changes Apr 9, 2025

View reviewed changes

zhenlan reviewed Apr 9, 2025

View reviewed changes

udpate

c623e5a

zhenlan reviewed Apr 9, 2025

View reviewed changes

update README

27d193b

zhenlan reviewed Apr 9, 2025

View reviewed changes

zhenlan approved these changes Apr 9, 2025

View reviewed changes

update

a3eeb9f

linglingye001 merged commit 4c1479b into release/v0 Apr 10, 2025
15 checks passed

linglingye001 deleted the linglingye/updateBoilerplates branch April 10, 2025 01:45


		The repository includes complete examples showing how to use the Go Provider in different scenarios:

		- [Console Application](./example/console-example/): Simple CLI app using App Configuration


		## Examples

		The repository includes complete examples showing how to use the Go Provider in different scenarios:

Update repo documents #3

Update repo documents #3

Uh oh!

Conversation

linglingye001 commented Mar 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants