Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lbiaggi committed Sep 27, 2024
1 parent 810466e commit 1e7b6ca
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion docs/reference/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,28 @@ In `path/to/file.yml`:
Some template text, which may
have several
lines.
```
```
# Beta Features

## External documents

**Note: When you use this feature, it is designed assuming that the external parent will be responsible for identifying the root document.**

It is possible to attach an external parent document (in other words an external git repo) as a parent to a local document.

The objective of this feature is to allow reusability of previous documents or even to split the work across multiple
repos.

To use this feature you need to modify `.doorstop.yml` to be similar to:

```yaml
external_parent: <GIT URL> <-- git url to used to pull the external parent **Required**
external_parent_tag: <GIT_TAG> <-- tag or branch to be used **REQUIRED**
settings:
parent: REQ <---- PREFIX from the external document **REQUIRED**
digits: 3
prefix: REQ
sep: ''
```

If you need to update the external tag or parent location, run doorstop with the flag `--clean-external-docs`.

0 comments on commit 1e7b6ca

Please sign in to comment.