[SPIKE] Which content re-use plugin should we use?

[omerbensaadon]

Recently, we've discussed a couple of content re-use plugins (Snippets, mdx-include, etc.) which of these plugins should we use?

Factors to consider:

• Ease of use by current docs writers (UX of leveraging snippets)
• Ability to fetch from remote repos (important for things like Ensure Reference content for Serving and Eventing is up-to-date and viewable  #3673
• We are already using Snippets so there would be minimal logistic effort to move off of that tool

[snneji]

/kind infrastructure
/priority medium

[omerbensaadon]

https://github.com/cmacmackin/markdown-include#configuration
https://github.com/neurobin/mdx_include
https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

[github-actions]

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

[snneji]

@abrennan89 are you still interested in working on this?

[abrennan89]

@snneji I was never working on / assigned to this, but it's still something we need, or at least that needs to be documented properly.

[snneji]

Could someone remind me why we want to change the content reuse plugin we use? What are the issues with the one we're currently using that will need to be solved by a new plugin?

[github-actions]

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

[snneji]

/lifecycle frozen

[abrennan89]

I think the biggest issue was not having stuff like offsets for headings, let's put a pin in this for now and revisit whether it still needs to be looked at when we have less on our plate.