Aspnetcore.docs: Sample Update Tracking Issue - complete list

[guardrex]

Updated (every repo sample checked): 6/27/2019
Otherwise, individual sample entries are updated here as sample update PRs are submitted (when the author remembers to do so :smile:).

| Latest | Current
Version | Topic + Notes |
| :---: | :---: | --- |
| guardrex | 5.0 | Blazor Common Sample |
| --- | 2.0 | Sample: client-side/bower/sample
Topic: bower.md |
| --- | 2.0 | Sample: client-side/bundling-and-minification/samples/BuildBundlerMinifierApp
Topic: bundling-and-minification.md |
| --- | 2.1 | client-side\libman\index.md |
| --- | 1.1 | Sample: client-side/spa-services/sample/SpaServicesSampleApp
Topic: spa-services.md |
| --- | 1.0 | common/samples/WebApplication1 used by static-files.md, migration/proper-to-2x/mvc2.md, mvc/views/layout.md, and mvc/views/overview.md |
| --- | 2.0 | common/samples/WebApplication1DotNetCore2.0App used by static-files.md |
| --- | 2.2 | data\ef-mvc\intro.md and sub-topics |
| --- | 2.1 | data\ef-rp\intro.md and sub-topics |
| --- | 1.0 | data/entity-framework-6/sample/MVCCore
Topic: entity-framework-6.md |
| --- | 2.2 | fundamentals\app-state.md |
| guardrex | 3.1 | fundamentals\change-tokens.md |
| guardrex | 3.1 | fundamentals\configuration\index.md |
| guardrex | 3.1 | fundamentals\configuration\options.md |
| guardrex | 3.1 | fundamentals\dependency-injection.md |
| guardrex | 2.2 | fundamentals\environments.md |
| tdykstra | 2.2 | fundamentals\error-handling.md |
| guardrex | 3.1 | fundamentals\file-providers.md (FileProviderSample, WatchConsole) |
| --- | 2.2 | fundamentals\host\generic-host.md |
| guardrex | 3.1 | fundamentals\host\hosted-services.md

Maintain/mod content from #15719? |
| guardrex | 3.0
net2.0 | fundamentals\host\platform-specific-configuration.md (5 projects) |
| guardrex
scottaddie | 3.1 | fundamentals\http-requests.md |
| hishamco | 2.1 | fundamentals\localization.md (Sample location: fundamentals/localization/sample/Localization) Also see :point_right: #15511 |
| --- | 1.0 | Sample: fundamentals/owin/sample
Topic: fundamentals\owin.md |
| tdykstra | 2.2 | fundamentals\logging\index.md |
| guardrex | 3.1 | fundamentals\logging\loggermessage.md |
| --- | 2.0 | fundamentals/metapackage/samples/Metapackage.All.Example.csproj |
| guardrex | 3.1 | fundamentals\middleware\extensibility.md |
| guardrex | 3.1 | fundamentals\middleware\extensibility-third-party-container.md |
| tdykstra | 3.0 | fundamentals\middleware\request-response.md |
| --- | 1.0 | Sample: fundamentals/owin/sample
Topic: fundamentals\owin.md |
| hishamco | 2.1 | fundamentals\portable-object-localization.md (Sample location: fundamentals/localization/sample/POLocalization) |
| guardrex | 3.1 | fundamentals\routing.md |
| guardrex | 3.1 | fundamentals\servers\httpsys.md |
| guardrex | 3.1 | fundamentals\servers\kestrel.md |
| --- | 3.0 | fundamentals\startup.md |
| --- | 1.0 | Sample: fundamentals/static-files/samples
Topic: fundamentals\static-files.md Feedback #5606 |
| guardrex | 3.1 | fundamentals\url-rewriting.md |
| tdykstra | 2.2 | fundamentals\websockets.md |
| tdykstra | 2.2 | getting-started/sample/Index.cshtml |
| Rick-Anderson | 3.0 | fundamentals/grpc/index.md and subtopics |
| JamesNK | 3.0 | grpc/authn-and-authz.md |
| scottaddie | 2.1 | host-and-deploy/docker/visual-studio-tools-for-docker.md |
| guardrex | 3.1 | host-and-deploy/health-checks.md |
| guardrex | 3.1 | host-and-deploy\windows-service.md |
| --- | 2.0 | migration\configuration.md |
| scottaddie | 2.2 | migration\webapi.md (ProductsApp, ProductsCore) |
| --- | 1.0 | Sample: mobile/native-mobile-backend/sample
Topic: mobile\native-mobile-backend.md |
| Rick-Anderson | 2.2 | Sample: mvc/advanced/app-parts/sample
Topic: mvc\advanced\app-parts.md |
| serpent5 | 2.1 | Sample: mvc/advanced/custom-model-binding/sample
Topic: mvc\advanced\custom-model-binding.md
See issue with the current sample/approach :point_right: #15470/#10341 |
| Rick-Anderson | 3.0 | mvc/compatibility-version.md |
| --- | 1.0 | Sample: mvc/controllers/application-model/sample
Topic: mvc/controllers/application-model.md |
| Rick-Anderson | 2.2 | mvc/controllers/areas.md (MVCareas, RPareas, WebApplication1, WebApplication2) |
| shadinamrouti | 2.2 | mvc\controllers\dependency-injection.md |
| --- | 1.1 | Sample: mvc/controllers/filters/sample
Topic: mvc\controllers\filters.md
Will fix: #6305 Add resource filter example; see https://github.com/aspnet/Docs/issues/8826 |
| --- | 1.0 | Sample: mvc/controllers/routing/sample
Topic: mvc/controllers/routing.md |
| guardrex | 3.0 | mvc\controllers\testing.md For additional enhancement opportunities, see the convos in #8147. Some integration tests in the sample (but not discussed in the topic) can possibly be moved to the integration testing topic; see #8157. |
| guardrex | 3.1 | mvc\models\file-uploads.md |
| tdykstra | 2.2 | mvc/models/model-binding.md |
| tdykstra | 2.2 | mvc/models/validation.md |
| --- | 1.0 | Sample: mvc/views/dependency-injection/sample
Topic: mvc\views\dependency-injection.md |
| scottaddie | 2.2 | mvc\views\partial.md |
| --- | 2.0 | Sample: mvc/views/razor/sample
Topic: mvc/views/razor.md |
| --- | 1.1 | Sample: mvc/views/tag-helpers/authoring/sample
Topic: mvc\views\tag-helpers\authoring.md |
| scottaddie | 2.1 | mvc\views\tag-helpers\built-in\anchor-tag-helper.md |
| Rick-Anderson | 2.1 | mvc/views/tag-helpers/th-components.md |
| --- | 1.1 | Sample: mvc/views/view-compilation/sample
Topic: mvc\views\view-compilation.md |
| shadinamrouti | 2.2 | mvc\views\view-components.md |
| --- | 1.0 | Sample: mvc/views/working-with-forms/sample
Topic: mvc\views\working-with-forms.md |
| guardrex | 3.1 | performance\caching\distributed.md |
| Rick-Anderson | 2.2 | performance\caching\memory.md (RPcache, WebCache) |
| guardrex | 3.1 | performance\caching\middleware.md |
| guardrex | 3.0 | performance\caching\response.md |
| Rick-Anderson | 2.2 | performance/objectPool.md |
| guardrex | 2.2 | performance\response-compression.md |
| --- | 2.1 | razor-pages\filter.md RC package present |
| --- | 2.0 | Sample: razor-pages/index/sample
Topic: razor-pages\index.md |
| guardrex | 3.1 | razor-pages\razor-pages-conventions.md |
| Rick-Anderson | 2.1 | razor-pages\sdk.md |
| --- | 2.0
2.1 | Sample: razor-pages/ui-class/samples
Topic: razor-pages\ui-class.md (RazorUIClassLib, WebApp1) |
| --- | 2.0
1.0 | Sample: security/anti-request-forgery/sample
Topic: security\anti-request-forgery.md (MVC, WebAPI for Angular) |
| --- | 2.1 | security/app-secrets.md |
| --- | 1.1 | Sample: security/authentication/2fa/sample
Topic: security\authentication\2fa.md |
| Rick-Anderson | 2.2 | security\authentication\accconfirm.md See: #6632, #6985 |
| Rick-Anderson | 3.0 | security\authentication\add-user-data.md |
| guardrex | 3.1 | security\authentication\cookie.md |
| scottaddie | 2.1 | security\authentication\customize-identity-model.md |
| Rick-Anderson | 2.1 | security\authentication\identity-configuration.md |
| --- | 1.1 | Sample: security/authentication/identity-custom-storage-providers/sample
Topic: security\authentication\identity-custom-storage-providers.md |
| Rick-Anderson | 2.2 | security\authentication\identity.md Fixes #7823 |
| HaoK | 2.1 | security\authentication\policyschemes.md |
| Rick-Anderson | 2.1 | security\authentication\scaffold-identity.md |
| guardrex | 3.1 | security\authentication\social\additional-claims.md |
| --- | 2.2 | security\authorization\policies.md (PoliciesAuthApp1, PoliciesAuthApp2) |
| guardrex | 3.1 | security\authorization\razor-pages-authorization.md |
| --- | 1.1 | Sample: security/authorization/resourcebased/samples
Topic: security\authorization\resourcedbased.md (ResourceBasedAuthApp1, ResourceBasedAuthApp2) |
| Rick-Anderson | 2.2 | security\authorization\roles.md |
| Rick-Anderson | 3.0 | security\authorization\secure-data.md |
| --- | | security\authorization\iauthorizationpolicyprovider.md The topic is using the AuthSamples engineering sample. Tracked by #9013. |
| Rick-Anderson | 2.2 | security\cors.md Three non-MVP/RP apps; one MVC app. All 1.x era. |
| Rick-Anderson | 2.1 | security/enforcing-ssl.md |
| Rick-Anderson | 2.1 | security/gdpr.md |
| tdykstra | 2.1 | security/ip-safelist.md |
| guardrex | 3.1 | security\key-vault-configuration.md |
| anurse | 2.1 | signalr/authn-and-authz.md |
| bradygaster | 2.2 | signalr/background-service.md (3 projects) |
| --- | 2.1 | signalr/dotnet-client.md (2 projects) |
| --- | 2.1 | signalr/groups.md |
| mikaelm12 | 2.1 | signalr/hubcontext.md |
| --- | 2.1 | signalr/hubs.md |
| --- | 2.1 | signalr/javascript-client.md |
| BrennanConroy | 3.0 | signalr/streaming.md |
| guardrex | 3.1 | test\integration-tests.md - Lacks the integration tests that were removed from testing controllers (see https://github.com/aspnet/Docs/pull/8157) |
| guardrex | 3.1 | test\razor-pages-tests.md |
| --- | 2.0 | Sample: tutorials/dotnet-watch/sample
Topic: tutorials/dotnet-watch.md (WebApp, WebAppTests) |
| scottaddie | 2.2 | tutorials/first-mongo-app.md |
| --- | 2.0 | Sample: tutorials/first-mvc-app-xplat/start-mvc/sample
Topic: tutorials/first-mvc-app-xplat.md |
| Rick-Anderson | 2.2 | tutorials/first-mvc-app.md |
| Rick-Anderson | 2.2 | tutorials/first-odata-api.md |
| scottaddie | 2.2 | tutorials\first-web-api.md |
| JamesNK | 3.0 | tutorials/grpc.md (GrpcGreeter, GrpcGreeterClient) |
| Rick-Anderson | 2.2 | tutorials/razor-pages/razor-pages-start.md |
| scottaddie | 2.1 | tutorials/signalr-typescript-webpack.md |
| tdykstra | 2.1 | tutorials/signalr.md |
| scottaddie | 2.1 | tutorials/web-api-help-pages-using-swagger.md RC packages present |
| scottaddie | 2.1 | web-api/action-return-types.md |
| scottaddie | 2.2 | web-api/advanced/conventions.md |
| tdykstra | 2.2 | web-api/advanced/custom-formatters.md |
| Rick-Anderson | 2.2 | Sample: web-api/advanced/formatting/sample
Topic: web-api/advanced/formatting.md |
| metoly | 2.2 | web-api/http-repl.md |
| tdykstra | 2.2 | web-api/index.md |
| tdykstra | 2.2 | web-api/jsonpatch.md |

[user135711]

On the in memory Caching sample, please add an explanation of how cache dependencies work. I've been trying to figure it out from the source code and debugger, and the Docs don't provide sufficient explanation:

    using (var entry = _cache.CreateEntry(CacheKeys.Parent))
    {
        // expire this entry if the dependant entry expires.
        entry.Value = DateTime.Now;
        entry.RegisterPostEvictionCallback(DependentEvictionCallback, this);

        _cache.Set(CacheKeys.Child,
            DateTime.Now,
            new CancellationChangeToken(cts.Token));
    }

How does the child token above communicate to the parent token to evict and what is the purpose of disposing of the parent token? Is this a hack where the parent eviction only occurs because the already marked as expired parent gets evicted when the child cancellation triggers a remove expired entries search? Second suggestion add to sample app a compilable version of this dependent cache entries construction because it makes more sense: https://github.com/aspnet/Caching/issues/48

[vsaranea]

I am struggling to figure out how to improve the performance of my shiny new Razor Pages/Page Model based app. I have some hefty partial page renders (sidebar icons based on heavy DB calls), which I want to cache (per-model).

I've tried using the tag helper, but I can't get the example working as expected.

Is there any ETA for the 2.1 release (with the attached docs drop), or better yet - a way to preview the docs as they are being written by Luke?

[guardrex]

Is there any ETA for the 2.1 release

The only ETA I'm aware of was given by Scott Hunter at the //Build conference when he said that they were aiming for sometime around the end of this month.

with the attached docs drop

The 2.1 docs are under continuous release now. They're rolling out almost daily. However, samples (this issue) will not be updated until 2.1 releases. We won't have 1.x, 2.0, and 2.1 samples ... only 1.x and 2.x (2.x will be 2.0 prior to 2.1 release; 2.x will become 2.1 after the 2.1 release). We don't want to break users using the latest stable release (2.0) until 2.1 actually hits the street.

[guardrex]

@Tratcher The HTTPsys sample isn't happy ("Secure connection failed") with HTTPS Redirection Middleware and ...

.UseHttpSys(options =>
{
    // The following options are set to default values.
    options.Authentication.Schemes = AuthenticationSchemes.None;
    options.Authentication.AllowAnonymous = true;
    options.MaxConnections = null;
    options.MaxRequestBodySize = 30000000;
    options.UrlPrefixes.Add("https://localhost:5001");
});

Should I not use the middleware in this sample ... or how do I fix this?

[EDIT] Seems like I would need to follow our guidance in Preregister URL prefixes to bind to HTTP.sys and set up x.509 certificates.

[Tratcher]

HttpSys https is hard to set up, we didn't do anything to improve that for 2.1. You don't need to add the middleware for this sample, the middleware usage/config wouldn't be any different here.

[guardrex]

Sounds good. Thx. I'll comment the line and add a quick note so that its existence is surfaced.

[Rick-Anderson]

there shouldn't be any harm if the folder is updated to samples (plural) at the same time.

Let's not do that. It's fine to have a sample folder with multiple samples under it.

[guardrex]

Let's not do that.

I'll need to revert some changes when I was preparing for 3.x (i.e., I was setting up a "2.x" folder for the work that will be coming for "3.x" in the future). Do you want me to go back and do that?

[Rick-Anderson]

Do you want me to go back and do that?

No, don't revert. Just stop making the change from sample to samples in future work.

[bplubell]

It sounds like this may already be on the radar, but wanted to mention it anyway. The security\authorization\razor-pages-authorization.md page has a link to a non-existent sample, which looks to have been removed when introducing the 2.x sample in #6835).

[guardrex]

Thanks for the heads-up. I'll take a look ... as soon as Gulf Power gets the electricity back on (Florida thunderstorm beat the crap out of us this afternoon).

[guardrex]

@bplubell Good news ... Link fixed by phone PR #6978 :+1: ... Bad news ... Gulf Power now says that equipment was destroyed by the storm ... No power until tomorrow. :fearful:

[spboyer]

bump. This is a huge issue. How are we keeping all of the samples up to date with the releases?

[guardrex]

@Rick-Anderson @scottaddie @tdykstra Poser, question, query ❓ ...

The new templates include a package for Razor support with MSBuild. This package isn't necessary for samples to run; however, it would be a nice-to-have and mirror-the-template philosophy to include it in sample apps ...

<PackageReference Include="Microsoft.AspNetCore.Razor.Design" Version="2.2.0" PrivateAssets="All" />

... sooooooooooooo .... do you want to include that?

I guess we're already leaning toward samples that take the in-proc prop ...

<AspNetCoreHostingModel>InProcess</AspNetCoreHostingModel>

... that's another one that isn't strictly required for sample apps to run. Under the mirror-the-template philosophy, Scott and I said†, 'Hell, yeah!'

†Well, I added the "hell" part. Scott just said "yeah" on that one. :smile:

[tdykstra]

This is the kind of "nice to have" that I wouldn't spend time on.

[guardrex]

Ok, but I'll eventually need firmer guidance. If we're dropping the in-proc prop into the file just because it's in the template, then doesn't it follow that this one should go in? I'm cool either way ... just asking what we're doing.

[scottaddie]

@guardrex I've been removing the Microsoft.AspNetCore.Razor.Design package reference, since it's not needed to demonstrate concepts in my docs. It's not worth the time to go back and remove them, but something to consider moving forward.

[guardrex]

Ok ... in-proc in and Razor.Design out. Sounds good to me. :+1:

[scottaddie]

@guardrex When displaying *.csproj file snippets, one less package reference makes a big difference in terms of readability.