Skip to content

Commit

Permalink
Merge pull request #1939 from rosahbruno/1897203-new-doc-links
Browse files Browse the repository at this point in the history
Bug 1897203 - remove links to old docs
  • Loading branch information
rosahbruno committed May 21, 2024
2 parents 7f6becf + 9d2a354 commit eca90f8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 12 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 general information on the Glean ecosystem and about the SDKs on other platforms, as well as reference to Glean APIs (which are common to all the platforms).

### [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:
Expand Down
6 changes: 3 additions & 3 deletions docs/implementation/plugins-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ 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.

## Core events

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.

Expand All @@ -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.
Expand Down

0 comments on commit eca90f8

Please sign in to comment.