From 8ee40a431988c4c61e392d2818970bfdf5ed7941 Mon Sep 17 00:00:00 2001 From: Bruno Rosa Date: Tue, 21 May 2024 01:52:16 -0400 Subject: [PATCH] Bug 1897203 - remove links to old docs --- README.md | 14 +++++--------- docs/implementation/plugins-events.md | 6 +++--- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b0cffd82c..1c331161b 100644 --- a/README.md +++ b/README.md @@ -8,22 +8,18 @@ All documentation is available online: +### [The Glean.js Docs](https://mozilla.github.io/glean.js/) + +If you are using Glean.js in your project, this is the place to go. + ### [The Glean Book](https://mozilla.github.io/glean/) -If you are using Glean.js in your project, this is the place to go. -It contains user guides on getting started and other topics, as well as reference to Glean APIs. +The Glean Book contains user guides on getting started and other topics, as well as reference to Glean APIs. ### [Glean.js developer documentation](https://github.com/mozilla/glean.js/tree/main/docs) If you want to contribute to the Glean.js code base this is the place to go. -### [Glean.js internal reference](https://mozilla.github.io/glean.js/) - -If you are looking for detailed documentation on the Glean APIs (internal or external) this is the place to go. - -_This documentation is auto generated from the doc comments throughout the Glean.js code base and -the Glean book should be preferred over this documentation whenever possible._ - ## Contact To contact us you can: diff --git a/docs/implementation/plugins-events.md b/docs/implementation/plugins-events.md index cbf5eba3b..3fc760204 100644 --- a/docs/implementation/plugins-events.md +++ b/docs/implementation/plugins-events.md @@ -4,7 +4,7 @@ Plugins provide a way for the Glean JS SDK to support specialized use cases with the size of the library. Each plugin can be attached to a Glean core event to augment or modify its behavior. -A Glean plugin is a class that extends the [`Plugin`](https://mozilla.github.io/glean.js/classes/plugins.default.html) class. Each plugin instance exposes an +A Glean plugin is a class that extends the `Plugin` class. Each plugin instance exposes an `action` API, to be triggered by the event. The signature of the `action` API will depend on the event the plugin is attached to. @@ -12,7 +12,7 @@ the event the plugin is attached to. Events denote a specific moment in code that may have a plugin attached to it. -A Glean event is an instance of the [`CoreEvent`](https://mozilla.github.io/glean.js/classes/core_events.CoreEvent.html) class. These instances expose a `trigger` API, +A Glean event is an instance of the `CoreEvent` class. These instances expose a `trigger` API, for triggering the action of a plugin that may be attached to it. Each event defines a different signature for the `trigger` API. @@ -24,7 +24,7 @@ we should create a new plugin and event for it. However, when is that? Plugins should always be the choice when we are implementing a feature that has a very specialized use case and would be left unused by most users. -The [`PingEncryptionPlugin`](https://mozilla.github.io/glean.js/classes/plugins_encryption.default.html) +The `PingEncryptionPlugin` is a good example of that. That plugin encrypts all outgoing pings when enabled. It is a fairly large plugin due to the encryption dependencies it includes in the bundle and it is only used by a small amount of clients. It makes sense to make it a stand-alone feature.