search

OrchardCMS / OrchardCore

Orchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework.
https://orchardcore.net
BSD 3-Clause "New" or "Revised" License
7.45k stars 2.41k forks source link

Document `ShapeResult.Cache()` #16664

Open Piedone opened 2 months ago

Piedone commented 2 months ago

Is your feature request related to a problem? Please describe.

ShapeResult.Cache() is a simple way to cache shapes created from drivers. It uses Dynamic Cache in a similar way as ShapeMetadata.Cache() does, but unlike that, it's not documented, and most possibly related to that, also underutilized (only the Notifications project uses it).

Describe the solution you'd like

Document it under https://docs.orchardcore.net/en/latest/reference/modules/DynamicCache/#caching-a-shape.

Describe alternatives you've considered

Adding examples to the Demo project, but it actually has two.

github-actions[bot] commented 2 months ago

We triaged this issue and set the milestone according to the priority we think is appropriate (see the docs on how we triage and prioritize issues).

This indicates when the core team may start working on it. However, if you'd like to contribute, we'd warmly welcome you to do that anytime. See our guide on contributions here.