Skip to content

Update cross-repo links syntax info #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mpdreamz merged 1 commit into from
Feb 28, 2025
Merged

Update cross-repo links syntax info #654

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/syntax/links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ The syntax follows the format `<scheme>://<path>`, where:
- `scheme`: The target repository name (e.g., kibana, beats)
- `path`: The file path within that repository

:::{important}
The `path` in cross-repo links must be relative to the `docset.yml` file and not the full path within the repo
:::

### External links

Link to websites and resources outside the Elastic docs:
Expand Down Expand Up @@ -139,4 +143,4 @@ This syntax exists to aid with migration. It is scheduled for removal and **shou

```markdown
Some text $$$custom-anchor$$$ more text
```
```