docs icon indicating copy to clipboard operation
docs copied to clipboard

[EPIC] Work on snippets infrastructure

Open abrennan89 opened this issue 4 years ago • 5 comments

TO DO:

  • [x] #3769
  • [x] #4556
    • Eg offset functionality so that snippets can be included at the correct heading level in different places.
  • [ ] #4557
  • [ ] #4558
  • [ ] QUESTION: Is a generic snippets folder the best way to store these, or should we have snippets organized by topic to make them easier to find?

This is just a brain dump for now, we can split these into individual issues in the epic as we assign / work on them.

Setting this as critical priority for the following reasons:

  • It would save us massive amounts of duplication in docs if we get our snippets properly in order.
  • Somewhat prevents reorg of content not having this ironed out, e.g. what when something needs to be included in both admin and dev guides? If we want to get rid of the serving and eventing sections, we need this soon.
  • The longer we take to do this, the more cleanup there will be to do from folks adding duplicate / additional content that should be part of a snippet.

abrennan89 avatar Jul 28 '21 19:07 abrennan89

@abrennan89 Has there been a decision on which snippets plugin we want to use? If so can we close https://github.com/knative/docs/issues/3769? If not we can add https://github.com/knative/docs/issues/3769 as the first issues in this epic.

snneji avatar Aug 23 '21 15:08 snneji

Hi @abrennan89, I would like to create the issues for this epic. Are you happy for me to create issues from the TO DO list? Is there anything else you would want added?

snneji avatar Dec 10 '21 15:12 snneji

@snneji I think that's fine to go ahead with, thanks

abrennan89 avatar Dec 10 '21 16:12 abrennan89

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.

github-actions[bot] avatar Mar 14 '22 01:03 github-actions[bot]

/lifecycle frozen

psschwei avatar May 14 '22 11:05 psschwei

Work to move sections to snippets is ongoing. I don't think this epic is required anymore.

abrennan89 avatar Sep 21 '22 14:09 abrennan89