Skip to content

Commit

Permalink
docs: update doc for V1
Browse files Browse the repository at this point in the history
  • Loading branch information
huang-julien authored Jan 29, 2025
1 parent 9f7350d commit 9bd25fe
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 20 deletions.
8 changes: 3 additions & 5 deletions docs/content/1.getting-started/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@ title: Introduction
description: Welcome to nuxt-applicationinsights documentation
---

::callout{color="danger" icon="i-material-symbols-warning"}
This module has not reached the first release yet. API may be subject to change.
::

Applicationinsights can be hard to implement within SSR frameworks where multiple SDK exist for different environnment.

This modules provides an integration of applicationinsights server side with \[nitro-applicationinsights]\(<https://github.com/huang-julien/nitro-applicationinsights>) and a client-side plugin to load \[applicationinsights web]\(<https://www.npmjs.com/package/@microsoft/applicationinsights-web>)
This modules provides an integration of applicationinsights server side with \[nitro-applicationinsights]\(<https://github.com/huang-julien/nitro-applicationinsights>) and a client-side plugin to load \[applicationinsights web]\(<https://www.npmjs.com/package/@microsoft/applicationinsights-web>).

\`nuxt-applicationinsights\` is only compatible with node for the`server-side integration.`
8 changes: 8 additions & 0 deletions docs/content/1.getting-started/3.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,11 @@ Enable \`nitro-applicationinsights\`, adding the server instance of \`applicatio
- default: **true**

Add a client-side plugin to initialize the ApplicationInsights instance and provide it to your nuxt instance.

## \`nitro-applicationinsights\`

See [nitro-applicationinsights runtime config documentation](https://huang-julien-nitro-applicationinsights.nuxt.space/guide/runtime-configuration)

## \`nitro-opentelemetry\`

See [nitro-opentelemetry documentation](https://github.com/huang-julien/nitro-opentelemetry)
35 changes: 20 additions & 15 deletions docs/content/index.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,35 @@
title: 'nuxt-applicationinsights'
title: nuxt-applicationinsights
description: nuxt-applicationinsights is a module for both server side and client side integration of Azure applicationinsights
navigation: false
hero:
title: 'nuxt-applicationinsights'
description: 'A nuxt module for both server and client side applicationinsights integration'
title: nuxt-applicationinsights
description: A nuxt module for both server and client side applicationinsights integration
orientation: horizontal
links:
- label: Get started
icon: i-heroicons-arrow-right-20-solid
trailing: true
to: '/getting-started'
to: /getting-started
size: lg
code: |
```bash [Terminal]
npx nuxi modules add nuxt-applicationinsights
```
features:
title: 'A ready to use module for applicationinsights'
title: A ready to use module for applicationinsights
items:
- title: 'Server side integration of applicationinsights'
description: 'Integrated with nitro-applicationinsights'
icon: 'i-mdi-server'
to: 'https://github.com/huang-julien/nitro-applicationinsights'
target: '_blank'
- title: 'Server side integration of applicationinsights'
description: 'Client side integration with @microsoft/applicationinsights-web'
icon: 'i-ph-browser'
to: 'https://github.com/microsoft/ApplicationInsights-JS'
target: '_blank'
- title: Server side integration of applicationinsights
description: Integrated with nitro-applicationinsights
icon: i-mdi-server
to: https://github.com/huang-julien/nitro-applicationinsights
target: _blank
- title: OpenTelemetry integration server side with nitro-opentelemetry
description: To modify your traces easily
icon: i-devicon-opentelemetry
to: https://github.com/huang-julien/nitro-opentelemetry
target: _blank
- title: Server side integration of applicationinsights
description: Client side integration with @microsoft/applicationinsights-web
icon: i-ph-browser
to: https://github.com/microsoft/ApplicationInsights-JS
target: _blank

0 comments on commit 9bd25fe

Please sign in to comment.