Skip to content

Commit 6acf389

Browse files
committed
docs: add docs to describe remote import feature
1 parent 26c73da commit 6acf389

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/web/src/content/docs/guides/setting-up-glossaries.mdx

+13-4
Original file line numberDiff line numberDiff line change
@@ -242,14 +242,23 @@ imports:
242242
+ - name: Shipping Fee
243243
```
244244

245-
In this case the `Shipping Fee` is a term that is relevant when integrating between `payments` and `shipping`.
245+
In this case the `Shipping Fee` is a term that is relevant when integrating between `payments` and `shipping`, but note that it is part of a separate Context - importing a file does not merge the contexts, rather, it acts as though all contexts were defined in the same file.
246246

247247
### Terms relevant across multiple repositories
248248

249-
If you have multiple repositories that would benefit from access to the same terms, then it's recommended to define the terms in one repository and to construct a system for copying them into the other repositories.
249+
If you have multiple repositories that would benefit from access to the same terms, then it's recommended to define the terms in one repository and publish them to a publicly accessibly URL.
250250

251-
:::tip[Coming Soon]
252-
A forthcoming update to Contextive will let you 'import' your glossary from a remote URL, which will make this pattern much simpler. Stay tuned!
251+
You can then use the [imports](#terms-relevant-in-multiple-places) feature and nominate the URL to import from:
252+
253+
```yml title="shipping/src/shipping.glossary.yml"
254+
imports:
255+
- "https://your.domain/path/to/shipping.glossary.yml"
256+
```
257+
258+
Any terminology defined in the yml file found at that URL will be made available within the path structure of the _importing_ file, as it is for local file imports.
259+
260+
:::danger
261+
Contextive does not support accessing authenticated remote URLs. If it's important that your glossaries remain private, at this point it's best to try and protect them by hosting them in locations only available on a corporate LAN/VPN or restrict access to them via a proxy.
253262
:::
254263

255264
### Multi-root workspaces

0 commit comments

Comments
 (0)