cleaning up more readmes

Author: eskirk

README.md

@@ -17,13 +17,13 @@ To install the Faro JavaScript bundler plugins, use the package manager of your
 To install the Webpack plugin with `npm`, run:
 
 ```bash
-npm install @grafana/faro-bundler-plugin-webpack
+npm install --save-dev @grafana/faro-bundler-plugin-webpack
 ```
 
 To install the Webpack plugin with `yarn`, run:
 
 ```bash
-yarn add @grafana/faro-bundler-plugin-webpack
+yarn add --dev @grafana/faro-bundler-plugin-webpack
 ```
 
 ### Rollup/Vite
@@ -33,13 +33,13 @@ Rollup and Vite are both supported by the same plugin.
 To install the Rollup/Vite plugin with `npm`, run:
 
 ```bash
-npm install @grafana/faro-bundler-plugin-rollup
+npm install --save-dev @grafana/faro-bundler-plugin-rollup
 ```
 
 To install the Rollup/Vite plugin with `yarn`, run:
 
 ```bash
-yarn add @grafana/faro-bundler-plugin-rollup
+yarn add --dev @grafana/faro-bundler-plugin-rollup
 ```
 
 ## Obtaining API key
@@ -48,7 +48,7 @@ yarn add @grafana/faro-bundler-plugin-rollup
 
 ## Usage
 
-Details of how to use the plugins with your bundler reside in the Frontend Observability plugin under the "Settings" -> "Web SDK Config" tab after clicking into your instrumented app.
+Details of how to use the plugins with your bundler reside in the Frontend Observability plugin under the "Settings" -> "Source Maps" tab after clicking into your instrumented app.
 
 That tab includes the necessary configuration for the Faro JavaScript bundler plugins, including the `appName`, `appId`, and `endpoint` values that you need for the plugins to work with your app. The details provided below are general instructions for how to use the plugins with your bundler.
 
@@ -106,10 +106,10 @@ export default defineConfig(({ mode }) => {
 The following options are available for the Faro JavaScript bundler plugins:
 
 - `appName: string` *required*: The name of your application. This should match the `appName` value you are using in your Faro Web SDK configuration.
-- `endpoint: string` *required*: The URL of your Faro Collector endpoint. This value is in the Frontend Observability plugin under "Settings" -> "Web SDK Config".
+- `endpoint: string` *required*: The URL of your Faro Collector endpoint. This value is in the Frontend Observability plugin under "Settings" -> "Source Maps".
 - `apiKey: string` *required*: The API key for your Faro Collector. This value gets generated on grafana.com by creating a new scope (details provided in the plugin and in the "Obtaining API key" section of this document).
 - `appId: string` *required*: The ID of your application. This should match the `appId` value you are using in your Faro Web SDK configuration.
-- `orgId: string` *required*: The ID of your organization. This value is in the Frontend Observability plugin under "Settings" -> "Web SDK Config".
+- `orgId: string` *required*: The ID of your organization. This value is in the Frontend Observability plugin under "Settings" -> "Source Maps".
 - `outputFiles: string[]` *optional*: An array of source map files to upload. By default, all source maps get uploaded.
 - `bundleId: string` *optional*: The ID of the bundle/build. You can specify this value to filter by bundle ID in the Frontend Observability plugin. Otherwise the bundler uses an auto-generated ID.
 - `keepSourcemaps: boolean` *optional*: Whether to keep the source maps in your generated bundle after uploading. Defaults to `false`.

packages/faro-rollup/README.md

@@ -1,4 +1,4 @@
-# Faro Source Map Upload Plugin - Rollup/Vite
+# Faro source map upload plugin - Rollup/Vite
 
 This plugin uploads source maps to the Faro collector to enable de-obfuscation of stack traces in the Grafana Cloud Frontend Observability UI.
 
@@ -20,9 +20,9 @@ yarn add --dev @grafana/faro-bundler-plugin-rollup
 
 ## Usage
 
-Details of how to use the plugins with your bundler are provided in the Frontend Observability plugin under the "Web SDK Configuration" tab after clicking into your instrumented app.
+Details of how to use the plugins with your bundler reside in the Frontend Observability plugin under the "Settings" -> "Source Maps" tab after clicking into your instrumented app.
 
-That tab includes the necessary configuration for the Faro JavaScript Bundler Plugins, including the `appName`, `appId`, and `endpoint` values that are required for the plugins to work with your app. The details provided below are general instructions for how to use the plugins with your bundler.
+That tab includes the necessary configuration for the Faro JavaScript bundler plugins, including the `appName`, `appId`, and `endpoint` values that you need for the plugins to work with your app. The details provided below are general instructions for how to use the plugins with your bundler.
 
 ### Rollup/Vite
 
@@ -51,19 +51,19 @@ export default defineConfig(({ mode }) => {
 
 ### Configuration Options
 
-The following options are available for the Faro JavaScript Bundler Plugins:
+The following options are available for the Faro JavaScript bundler plugins:
 
-- `appName: string` (required): The name of your application. This should match the `appName` value you are using in your Faro Web SDK configuration.
-- `endpoint: string` (required): The URL of your Faro Collector endpoint. This value is generated in the Frontend Observability plugin under "Web SDK Configuration".
-- `apiKey: string` (required): The API key for your Faro Collector. This value is generated on grafana.com by creating a new scope (details provided in the plugin and in the "Obtaining API Key" section of this document).
-- `appId: string` (required): The ID of your application. This should match the `appId` value you are using in your Faro Web SDK configuration.
-- `orgId: string` (required): The ID of your organization. This value is provided in the Frontend Observability plugin under "Web SDK Configuration".
-- `outputFiles: string[]` (optional): An array of sourcemap files to upload. By default, all sourcemaps are uploaded.
-- `bundleId: string` (optional): The ID of the bundle/build. You can specify this value to filter by bundle ID in the Frontend Observability plugin. Otherwise an auto-generated ID will be used.
-- `keepSourcemaps: boolean` (optional): Whether to keep the sourcemaps in your generated bundle after uploading. Defaults to `false`.
-- `gzipContents: boolean` (optional): Whether to tarball and gzip the contents of the sourcemaps before uploading. Defaults to `true`.
-- `verbose: boolean` (optional): Whether to log verbose output during the upload process. Defaults to `false`.
+- `appName: string` *required*: The name of your application. This should match the `appName` value you are using in your Faro Web SDK configuration.
+- `endpoint: string` *required*: The URL of your Faro Collector endpoint. This value is in the Frontend Observability plugin under "Settings" -> "Source Maps".
+- `apiKey: string` *required*: The API key for your Faro Collector. This value gets generated on grafana.com by creating a new scope (details provided in the plugin and in the "Obtaining API key" section of this document).
+- `appId: string` *required*: The ID of your application. This should match the `appId` value you are using in your Faro Web SDK configuration.
+- `orgId: string` *required*: The ID of your organization. This value is in the Frontend Observability plugin under "Settings" -> "Source Maps".
+- `outputFiles: string[]` *optional*: An array of source map files to upload. By default, all source maps get uploaded.
+- `bundleId: string` *optional*: The ID of the bundle/build. You can specify this value to filter by bundle ID in the Frontend Observability plugin. Otherwise the bundler uses an auto-generated ID.
+- `keepSourcemaps: boolean` *optional*: Whether to keep the source maps in your generated bundle after uploading. Defaults to `false`.
+- `gzipContents: boolean` *optional*: Whether to tarball and Gzip the contents of the source maps before uploading. Defaults to `true`.
+- `verbose: boolean` *optional*: Whether to log verbose output during the upload process. Defaults to `false`.
 
-After initial configuration, the Faro JavaScript Bundler Plugins will automatically upload your source maps to Grafana Cloud when you build your application. You can verify that the source maps are being uploaded by "Sourcemaps" tab in the Frontend Observability plugin. From there you are able to see the source maps that have been uploaded.
+After initial configuration, the Faro JavaScript bundler plugins automatically uploads your source maps to Grafana Cloud when you build your application. You can verify that the source maps upload successfully by in the "Settings" -> "Source Maps" tab in the Frontend Observability plugin. From there you are able to see the source maps that you have uploaded.
 
-Once you have completed all the required steps, you are done - the Faro Collector will begin processing your source maps and associating them with your telemetry data. The portions of your stacktraces with source maps that have been uploaded to the Faro Collector will be automatically deobfuscated and displayed in the Frontend Observability plugin when viewing your error data.
+After you have completed all the required steps, you have finished - the Faro Collector begins processing your source maps and associating them with your telemetry data. The portions of your stack traces with source maps uploaded to the Faro Collector are automatically de-obfuscated and displayed in the Frontend Observability plugin when viewing your error data.

packages/faro-webpack/README.md

@@ -1,10 +1,10 @@
-# Faro Source Map Upload Plugin - Webpack
+# Faro source map upload plugin - Webpack
 
 This plugin uploads source maps to the Faro collector to enable de-obfuscation of stack traces in the Grafana Cloud Frontend Observability UI.
 
 ## Installation
 
-To install the Faro JavaScript Bundler Plugins for Webpack, use the package manager of your choice.
+To install the Faro JavaScript bundler plugins for Webpack, use the package manager of your choice.
 
 ```bash
 npm install --save-dev @grafana/faro-bundler-plugin-webpack
@@ -18,9 +18,9 @@ yarn add --dev @grafana/faro-bundler-plugin-webpack
 
 ## Usage
 
-Details of how to use the plugins with your bundler are provided in the Frontend Observability plugin under the "Web SDK Configuration" tab after clicking into your instrumented app.
+Details of how to use the plugins with your bundler reside in the Frontend Observability plugin under the "Settings" -> "Source Maps" tab after clicking into your instrumented app.
 
-That tab includes the necessary configuration for the Faro JavaScript Bundler Plugins, including the `appName`, `appId`, and `endpoint` values that are required for the plugins to work with your app. The details provided below are general instructions for how to use the plugins with your bundler.
+That tab includes the necessary configuration for the Faro JavaScript bundler plugins, including the `appName`, `appId`, and `endpoint` values that you need for the plugins to work with your app. The details provided below are general instructions for how to use the plugins with your bundler.
 
 To use the Webpack plugin, add the following to your `webpack.config.js`:
 
@@ -46,19 +46,19 @@ module.exports = {
 
 ### Configuration Options
 
-The following options are available for the Faro JavaScript Bundler Plugins:
+The following options are available for the Faro JavaScript bundler plugins:
 
-- `appName: string` (required): The name of your application. This should match the `appName` value you are using in your Faro Web SDK configuration.
-- `endpoint: string` (required): The URL of your Faro Collector endpoint. This value is generated in the Frontend Observability plugin under "Web SDK Configuration".
-- `apiKey: string` (required): The API key for your Faro Collector. This value is generated on grafana.com by creating a new scope (details provided in the plugin and in the "Obtaining API Key" section of this document).
-- `appId: string` (required): The ID of your application. This should match the `appId` value you are using in your Faro Web SDK configuration.
-- `orgId: string` (required): The ID of your organization. This value is provided in the Frontend Observability plugin under "Web SDK Configuration".
-- `outputFiles: string[]` (optional): An array of sourcemap files to upload. By default, all sourcemaps are uploaded.
-- `bundleId: string` (optional): The ID of the bundle/build. You can specify this value to filter by bundle ID in the Frontend Observability plugin. Otherwise an auto-generated ID will be used.
-- `keepSourcemaps: boolean` (optional): Whether to keep the sourcemaps in your generated bundle after uploading. Defaults to `false`.
-- `gzipContents: boolean` (optional): Whether to tarball and gzip the contents of the sourcemaps before uploading. Defaults to `true`.
-- `verbose: boolean` (optional): Whether to log verbose output during the upload process. Defaults to `false`.
+- `appName: string` *required*: The name of your application. This should match the `appName` value you are using in your Faro Web SDK configuration.
+- `endpoint: string` *required*: The URL of your Faro Collector endpoint. This value is in the Frontend Observability plugin under "Settings" -> "Source Maps".
+- `apiKey: string` *required*: The API key for your Faro Collector. This value gets generated on grafana.com by creating a new scope (details provided in the plugin and in the "Obtaining API key" section of this document).
+- `appId: string` *required*: The ID of your application. This should match the `appId` value you are using in your Faro Web SDK configuration.
+- `orgId: string` *required*: The ID of your organization. This value is in the Frontend Observability plugin under "Settings" -> "Source Maps".
+- `outputFiles: string[]` *optional*: An array of source map files to upload. By default, all source maps get uploaded.
+- `bundleId: string` *optional*: The ID of the bundle/build. You can specify this value to filter by bundle ID in the Frontend Observability plugin. Otherwise the bundler uses an auto-generated ID.
+- `keepSourcemaps: boolean` *optional*: Whether to keep the source maps in your generated bundle after uploading. Defaults to `false`.
+- `gzipContents: boolean` *optional*: Whether to tarball and Gzip the contents of the source maps before uploading. Defaults to `true`.
+- `verbose: boolean` *optional*: Whether to log verbose output during the upload process. Defaults to `false`.
 
-After initial configuration, the Faro JavaScript Bundler Plugins will automatically upload your source maps to Grafana Cloud when you build your application. You can verify that the source maps are being uploaded by "Sourcemaps" tab in the Frontend Observability plugin. From there you are able to see the source maps that have been uploaded.
+After initial configuration, the Faro JavaScript bundler plugins automatically uploads your source maps to Grafana Cloud when you build your application. You can verify that the source maps upload successfully by in the "Settings" -> "Source Maps" tab in the Frontend Observability plugin. From there you are able to see the source maps that you have uploaded.
 
-Once you have completed all the required steps, you are done - the Faro Collector will begin processing your source maps and associating them with your telemetry data. The portions of your stacktraces with source maps that have been uploaded to the Faro Collector will be automatically deobfuscated and displayed in the Frontend Observability plugin when viewing your error data.
+After you have completed all the required steps, you have finished - the Faro Collector begins processing your source maps and associating them with your telemetry data. The portions of your stack traces with source maps uploaded to the Faro Collector are automatically de-obfuscated and displayed in the Frontend Observability plugin when viewing your error data.