microsoft / microsoft/aspire-samples

[Feature Request] For samples, use appsettings.Development.json for secrets to help with learning

Open
#404 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area-samples
Dominant language
C#
Stars
1.2k
Forks
345
Avg merge
3d 13h
Merged PRs (30d)
30

Description

Hi team, I'm learning Aspire as quickly as possible (and loving it!) but have had one or two issues along the way getting the formatting of secrets correct. Since the samples repo is meant to be a learning aid, I'd like to recommend that secrets are included using dummy values in the appsettings.Development.json file. This way, those who are learning the framework will have a better understanding of how their secrets should be formatted and what a correct value might look like. The documentation simply says to include the connection string or endpoint value and includes a statement about what will be looked for in the user secrets, but seeing it in a repo is always better. Of course, include a disclaimer that user secrets should be the preferred approach, and possibly include a link to the MS Learn docs page for setting up user secrets to further encourage good practices. But for a learning approach, it would be very helpful to see everything that goes into a successful project.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the sample projects that use secrets and their appsettings.Development.json files, then review the existing user-secrets guidance. Done means representative dummy values are shown for the required secrets, with a disclaimer favoring user secrets and a link to the Microsoft Learn setup documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.