[Feature Request]: Global Snippets to reduce maintenance work across docs

Open
#2,950 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
csharp
Domain
documentation, tooling

Research direction

The issue does not identify files, tests, or an entry point. Start by mapping how docs-builder currently handles shared content and links across repositories, then define where externally maintained snippets would live, how they would be referenced, and how updates would be validated; done means an agreed design and working end-to-end example.

Written by the indexing model from the issue text.

Description

ai-triaged ai:eng-question ai:writer-question enhancement needs triage
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?

Whenever a reorg happens and/or ownership of products change within a company, we have to go through all our docs/repositories to update department entries and/or standardized messaging, for example the quote below.

Reach out to [Team X](Link to our support channel) in case you need more help.

One could use redirects to have a long-standing link, but the "Team X" text would still require changes across all repositories owned by the team, and with that, all the approval and release process.

Proposed Solution

Have a space (somewhere) I can link to outside the current product's documentation.

Examples and Research

Notion has Synced blocks for this purpose.

Alternative Solutions

No response

Additional Context

I have been discussing this feature with @theletterf, @reakaleek, and @Mpdreamz internally (thread).

How important is this feature to you?

Nice to have

Dominant language
C#
Stars
25
Forks
44
Avg merge
22h 15m
Merged PRs (30d)
162

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/docs-builder

All issues in elastic/docs-builder

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.