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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This repository is a pnpm and .NET workspace. The most relevant folders:
| `src/TheBuilder.WebAnalytics/Client/` | The backoffice frontend (TypeScript, Lit, Vite). Built assets are emitted to `wwwroot/App_Plugins/`. |
| `samples/TheBuilder.WebAnalytics.Example/` | A runnable Umbraco site that references the package for local development. |
| `tests/TheBuilder.WebAnalytics.Tests/` | The .NET (xUnit) test project. Frontend tests (Vitest) live beside the client source. |
| `apps/docs/` | The documentation site (Blume) published to <https://umbraco-web-analytics.vercel.app/>. |
| `apps/docs/` | The documentation site (Blume) published to <https://web-analytics.thebuilder.dk/>. |
| `docs/releasing.md` | How package versions are published to NuGet. |

## Prerequisites
Expand Down Expand Up @@ -44,7 +44,7 @@ The example project references the package directly, so it always uses your loca
dotnet run --project samples/TheBuilder.WebAnalytics.Example
```

On first launch Umbraco installs unattended and creates a local SQLite database. In `Development` the sample enables mock connections (`WebAnalytics:EnableMockConnections`), so the Analytics section shows deterministic sample data without any Vercel or Plausible credential. For live data, configure a real provider credential and connection exactly as a consumer would (see the [Quickstart](https://umbraco-web-analytics.vercel.app/quickstart)).
On first launch Umbraco installs unattended and creates a local SQLite database. In `Development` the sample enables mock connections (`WebAnalytics:EnableMockConnections`), so the Analytics section shows deterministic sample data without any Vercel or Plausible credential. For live data, configure a real provider credential and connection exactly as a consumer would (see the [Quickstart](https://web-analytics.thebuilder.dk/quickstart)).

For an efficient loop, run `pnpm client:watch` in one terminal and `dotnet run` in another.

Expand Down Expand Up @@ -77,4 +77,4 @@ The `apps/docs/` content is Markdown/MDX; see the files under `apps/docs/docs/`

## Releasing

Publishing packages to NuGet is release-driven and documented separately in [docs/releasing.md](docs/releasing.md). GitHub Releases are the authoritative changelog and are surfaced in the [documentation changelog](https://umbraco-web-analytics.vercel.app/changelog/).
Publishing packages to NuGet is release-driven and documented separately in [docs/releasing.md](docs/releasing.md). GitHub Releases are the authoritative changelog and are surfaced in the [documentation changelog](https://web-analytics.thebuilder.dk/changelog/).
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ To let non-admin editors see reporting, grant the **Analytics** section to their

| Provider | Identifier | Credential |
| --- | --- | --- |
| [Vercel Web Analytics](https://umbraco-web-analytics.vercel.app/providers/vercel) | Project ID (`prj_...`) and optional team | Scoped access token |
| [Plausible](https://umbraco-web-analytics.vercel.app/providers/plausible) | Site ID, normally the registered domain | Stats API key |
| [Vercel Web Analytics](https://web-analytics.thebuilder.dk/providers/vercel) | Project ID (`prj_...`) and optional team | Scoped access token |
| [Plausible](https://web-analytics.thebuilder.dk/providers/plausible) | Site ID, normally the registered domain | Stats API key |

Plausible Cloud's Stats API requires a Business plan. Self-hosted Plausible is supported when its instance exposes the v2 Stats API query endpoint.

Expand Down Expand Up @@ -95,17 +95,17 @@ Besides the provider credentials above, these tunables live under the `WebAnalyt
| `Connections` | `[]` | Provider connection definitions. The first becomes the initial default. |
| `EnableMockConnections` | `false` | Development-only deterministic connection presets. Never enable in production. |

Connections are normally created through the Settings screen, but they can also be bootstrapped from configuration for deployment automation. The [configuration reference](https://umbraco-web-analytics.vercel.app/reference/configuration) documents every connection key and the full precedence rules.
Connections are normally created through the Settings screen, but they can also be bootstrapped from configuration for deployment automation. The [configuration reference](https://web-analytics.thebuilder.dk/reference/configuration) documents every connection key and the full precedence rules.

## Documentation

The full documentation site covers everything above in more depth, plus the reporting UI and per-provider capabilities:

- [Quickstart](https://umbraco-web-analytics.vercel.app/quickstart): install, connect a provider, and verify the dashboard.
- [Understanding your reports](https://umbraco-web-analytics.vercel.app/guides/reports): what each metric, breakdown, and control means.
- [Document analytics](https://umbraco-web-analytics.vercel.app/guides/document-analytics): show page-level reports on mapped documents.
- [Configuration reference](https://umbraco-web-analytics.vercel.app/reference/configuration) and [troubleshooting](https://umbraco-web-analytics.vercel.app/reference/troubleshooting).
- [Quickstart](https://web-analytics.thebuilder.dk/quickstart): install, connect a provider, and verify the dashboard.
- [Understanding your reports](https://web-analytics.thebuilder.dk/guides/reports): what each metric, breakdown, and control means.
- [Document analytics](https://web-analytics.thebuilder.dk/guides/document-analytics): show page-level reports on mapped documents.
- [Configuration reference](https://web-analytics.thebuilder.dk/reference/configuration) and [troubleshooting](https://web-analytics.thebuilder.dk/reference/troubleshooting).

## Contributing

Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the repository layout, local development setup (building the backoffice client, running the sample site, and running the tests), and how to submit a pull request. NuGet publishing guidance is in [docs/releasing.md](docs/releasing.md). GitHub Releases are the authoritative changelog and are surfaced in the [documentation changelog](https://umbraco-web-analytics.vercel.app/changelog/).
Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the repository layout, local development setup (building the backoffice client, running the sample site, and running the tests), and how to submit a pull request. NuGet publishing guidance is in [docs/releasing.md](docs/releasing.md). GitHub Releases are the authoritative changelog and are surfaced in the [documentation changelog](https://web-analytics.thebuilder.dk/changelog/).
2 changes: 1 addition & 1 deletion apps/docs/blume.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export default defineConfig({
redirects: [{ from: "/getting-started", to: "/quickstart", status: 301 }],
deployment: {
output: "static",
site: "https://umbraco-web-analytics.vercel.app",
site: "https://web-analytics.thebuilder.dk",
},
analytics: {
vercel: true,
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/umbraco-package.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export const webAnalyticsPackage = defineUmbracoPackage({
name: "Web Analytics",
summary: "Connect analytics providers and bring site-wide and page-level insights into the Umbraco backoffice.",
links: {
docs: "https://umbraco-web-analytics.vercel.app/",
docs: "https://web-analytics.thebuilder.dk/",
nuget: "https://www.nuget.org/packages/TheBuilder.WebAnalytics",
marketplace: "https://marketplace.umbraco.com/package/thebuilder.webanalytics",
github: "https://github.com/thebuilder/web-analytics",
Expand All @@ -21,7 +21,7 @@ export const blurPlaceholderPackage = defineUmbracoPackage({
name: "Blur Placeholder",
summary: "Generate WebP, BlurHash, or ThumbHash placeholders for Umbraco Image media and deliver one frontend-ready string.",
links: {
docs: "https://blur-placeholder.vercel.app/",
docs: "https://blur.thebuilder.dk/",
nuget: "https://www.nuget.org/packages/TheBuilder.BlurPlaceholder",
marketplace: "https://marketplace.umbraco.com/package/thebuilder.blurplaceholder",
github: "https://github.com/thebuilder/blur-placeholder",
Expand Down
2 changes: 1 addition & 1 deletion umbraco-marketplace-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Web Analytics brings analytics from [**Vercel Web Analytics**](https://vercel.co

Web Analytics fits into the Umbraco permissions and editorial workflows teams already know, making analytics available where content decisions happen.

Ready to bring your analytics into the backoffice? See the [installation and configuration guide](https://umbraco-web-analytics.vercel.app/).
Ready to bring your analytics into the backoffice? See the [installation and configuration guide](https://web-analytics.thebuilder.dk/).
2 changes: 1 addition & 1 deletion umbraco-marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"Category": "Analytics & Insights",
"Title": "Web Analytics",
"Description": "Connect web analytics providers and bring site-wide and page-level insights into the Umbraco backoffice.",
"DocumentationUrl": "https://umbraco-web-analytics.vercel.app/",
"DocumentationUrl": "https://web-analytics.thebuilder.dk/",
"IssueTrackerUrl": "https://github.com/thebuilder/web-analytics/issues",
"LicenseTypes": [
"Free"
Expand Down
Loading