Skip to content

Commit

Permalink
Fix links to several more pages
Browse files Browse the repository at this point in the history
These actually work because we add some redirects, but this change makes
local testing easier.

[doc only]
  • Loading branch information
badboy committed Nov 8, 2023
1 parent 7d18adf commit e6832cb
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/dev/core/internal/implementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
[^5]: Sent on startup when pending events are stored and when reaching the limit. Additionally sent when [`handle_client_inactive`][rs_client_inactive] is called.


[py_client_active]: ../../../python/glean/#glean.Glean.handle_client_active
[py_client_inactive]: ../../../python/glean/#glean.Glean.handle_client_inactive
[py_client_active]: ../../../python/glean/index.html#glean.Glean.handle_client_active
[py_client_inactive]: ../../../python/glean/index.html#glean.Glean.handle_client_inactive
[rs_client_active]: ../../../docs/glean/fn.handle_client_active.html
[rs_client_inactive]: ../../../docs/glean/fn.handle_client_inactive.html
[rs_configuration]: ../../../docs/glean/struct.Configuration.html
2 changes: 1 addition & 1 deletion docs/dev/core/new-metric-type/rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,5 @@ pub use glean_core::Counter;
## Documentation

Don't forget to document the new Rust API in the Book's page on the Metric Type
(e.g. [Counter](../../../book/user/metrics/counter.html)).
(e.g. [Counter](../../../book/reference/metrics/counter.html)).
Add a tab for Rust, and mimic any other language's example.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Glean in an Android project.

Since crashes will be instrumented with some custom metrics, the next step will be to add a `metrics.yaml` file to define the
metrics used to record the crash information and a `pings.yaml` file to define a custom ping which will give some control over
the scheduling of the uploading. See ["Adding new metrics"](../../user/adding-new-metrics.md) for more information about adding metrics.
the scheduling of the uploading. See ["Adding new metrics"](../../user/metrics/adding-new-metrics.md) for more information about adding metrics.

What metric type should be used to represent the crash data? While this could be implemented several ways, an [event](../../reference/metrics/event.md) is an
excellent choice, simply because events capture information in a nice concise way and they have a built-in way of passing
Expand Down
2 changes: 1 addition & 1 deletion docs/user/user/pings/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ timestamps are always increasing.

##### Checking for decreasing time offsets between restarts

> When this edge case is hit, Glean records an [`InvalidValue` error](../error-reporting.md)
> When this edge case is hit, Glean records an [`InvalidValue` error](../metrics/error-reporting.md)
> for the `glean.restarted` metric. This metric may be consulted at analysis time.
> It is sent in the same ping where the error happened.

Expand Down
2 changes: 1 addition & 1 deletion docs/user/user/pings/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ option can be changed at [initialization](../../reference/general/initializing.m
> Since the Glean Python and JavaScript SDKs don't have a generic concept of "inactivity",
> case (1) above cannot be handled automatically.
>
> On Python, users can call the [`handle_client_inactive`](../../../python/glean/#glean.Glean.handle_client_inactive)
> On Python, users can call the [`handle_client_inactive`](../../../python/glean/index.html#glean.Glean.handle_client_inactive)
> API to let Glean know the app is inactive and that will trigger submission of the `events` ping.
>
> On JavaScript there is no such API and only cases (2) and (3) apply.
Expand Down
2 changes: 1 addition & 1 deletion docs/user/user/pings/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Every ping payload has the following keys at the top-level:
The following keys are only present if any metrics or events were recorded for the given ping:

- The `metrics` section contains the submitted values for all metric types
except for [events](../metrics/event.md). It has keys for each of the metric types,
except for [events](../../reference/metrics/event.md). It has keys for each of the metric types,
under which is data for each metric.

- The `events` section contains the events recorded in the ping.
Expand Down
4 changes: 2 additions & 2 deletions docs/user/user/pings/sent-by-glean.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ There is also a [high-level overview](ping-schedules-and-timings.html) of how th
| JavaScript |||||
| Firefox Desktop |||||

[^1]: Not sent automatically. Use the [`handle_client_active`](../../../python/glean/#glean.Glean.handle_client_active) and [`handle_client_inactive`](../../../python/glean/#glean.Glean.handle_client_inactive) API.
[^1]: Not sent automatically. Use the [`handle_client_active`](../../../python/glean/index.html#glean.Glean.handle_client_active) and [`handle_client_inactive`](../../../python/glean/index.html#glean.Glean.handle_client_inactive) API.

[^2]: Sent on startup when pending events are stored. Additionally sent when [`handle_client_inactive`](../../../python/glean/#glean.Glean.handle_client_inactive) is called.
[^2]: Sent on startup when pending events are stored. Additionally sent when [`handle_client_inactive`](../../../python/glean/index.html#glean.Glean.handle_client_inactive) is called.

## Defining foreground and background state

Expand Down

0 comments on commit e6832cb

Please sign in to comment.