Skip to content

[Feature Request]: Allow including code samples across repos #712

Open
@colleenmcginnis

Description

@colleenmcginnis

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

This might be a unique use case, but in the past the APM docs we stored some sample code in the elastic/apm-server repo where engineers generate and maintain the files (example) and included them in the narrative content (example).

Proposed Solution

There are a few ways we could address this (some within docs-builder and others outside it):

  • Allow cross-repo file inclusion.
  • Use GitHub actions to sync the apm-server files with copies of the files in docs-content.
  • Remove the snippets from the docs in these cases and just add a link to the GitHub page.

Examples and Research

No response

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Nice to have

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions