Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 2 additions & 39 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,48 +15,11 @@ This packages aims to help developers quickly put together Umbraco Dashboards us
- Supports both Views & View Components
- Easy to define section permissions

> [!IMPORTANT]
> Version 15 will only receive security updates and no new features.
> [!WARNING]
> Version 15 is no longer supported and is End of Life (EOL).

> Please review the [security policy](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=security-ov-file#supported-versions) for more information.

## Quick Start

### Install Package

```csharp
dotnet add package Umbraco.Community.SimpleDashboards
```

### Register Dashboard

By default, this will display in the content section for Admins only.

```csharp title="BasicDashboard.cs"
using Umbraco.Community.SimpleDashboards.Web;
public class BasicDashboard : SimpleDashboard { }
```

### Create View

- Your view **must** go in `/Views/Dashboard`
- You view **must** be the name of your C# class (without `Dashboard`)
- For example: `BasicDashboard.cs` => `/Views/Dashboard/Basic.cshtml`

```csharp title="Views/Dashboard/Basic.cshtml"
@inherits Umbraco.Community.SimpleDashboards.Web.DashboardViewPage

<uui-box headline="Hello Umbraco">
<p>My Dashboard is: @Model.Dashboard.Alias</p>
</uui-box>
```

### More Examples

[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v15/docs/examples.md)



## Contributing

Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page.
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Build
uses: jcdcdev/jcdcdev.Umbraco.Github.Build@main
uses: jcdcdev/jcdcdev.Umbraco.GitHub.Build@v0
with:
project-name: Umbraco.Community.SimpleDashboards
project-path: src/Umbraco.Community.SimpleDashboards/Umbraco.Community.SimpleDashboards.csproj
npm-working-dir: src/Umbraco.Community.SimpleDashboards.Client
npm-enabled: true
umbraco-version: 15
dotnet-version: "9"
npm-version: "22.x"
npm-version: "22.x"
8 changes: 4 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: 🚀 Release
on:
workflow_dispatch:
pull_request:
types: [ closed ]
types: [closed]
jobs:
release:
if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
Expand All @@ -13,7 +13,7 @@ jobs:
steps:
- name: Build
id: build
uses: jcdcdev/jcdcdev.Umbraco.GitHub.Build@main
uses: jcdcdev/jcdcdev.Umbraco.GitHub.Build@v0
with:
project-name: Umbraco.Community.SimpleDashboards
project-path: src/Umbraco.Community.SimpleDashboards/Umbraco.Community.SimpleDashboards.csproj
Expand All @@ -23,9 +23,9 @@ jobs:
dotnet-version: "9"
npm-version: "22.x"
- name: Release
uses: jcdcdev/jcdcdev.Umbraco.GitHub.Release@main
uses: jcdcdev/jcdcdev.Umbraco.GitHub.Release@v0
with:
artifact-name: ${{ steps.build.outputs.artifact-name }}
version: ${{ steps.build.outputs.version }}
nuget-api-key: ${{ secrets.NUGET_API_KEY }}
github-token: ${{ secrets.GITHUB_TOKEN }}
github-token: ${{ secrets.GITHUB_TOKEN }}
Loading
Loading