Skip to content

Commit

Permalink
Reference data-embed package in app-context documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick Colley committed May 12, 2020
1 parent 6ba6ee8 commit ed8d922
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/dotcom-server-app-context/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This package provides tools to define FT app context data and a [JSON schema] de

To learn more about why this feature exists please review the [design document]. To find out which properties can be defined please refer to the [app context schema].

_Please note_ that all app context properties will be appended to every tracking event sent to Spoor. For this reason it is very important not to pollute the schema.
If you want to share application specific data with the client, consider using [@financial-times/dotcom-ui-data-embed](../dotcom-ui-data-embed).

[JSON schema]: https://json-schema.org/
[design document]: ../../docs/design-decisions/app-context.md
Expand Down
1 change: 1 addition & 0 deletions packages/dotcom-ui-app-context/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This package provides methods for embedding [app context data] into your server-

[app context data]: ../dotcom-server-app-context/schema.md

If you want to share application specific data with the client, consider using [@financial-times/dotcom-ui-data-embed](../dotcom-ui-data-embed).

## Getting started

Expand Down

0 comments on commit ed8d922

Please sign in to comment.