techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

Consolidate howto/website-guidelines-checklist and the original guidelines?

Open chalin opened this issue 4 years ago • 3 comments
trafficstars

The website-guidelines-checklist.md file is very useful indeed, but I'm thinking that it would be even better if the original guide was written in a check-list format. That way we can avoid having these documents drift.

WDYT?

chalin avatar Oct 28 '21 19:10 chalin

Which files are you referring to as original guidelines?

If we're looking to de-duplicate, can we link out to them? Or is it still better to have these in two different spots? (Also, is there a way to embed a .md file in another .md file?)

nate-double-u avatar Oct 28 '21 22:10 nate-double-u

Which files are you referring to as original guidelines?

https://github.com/cncf/foundation/blob/master/website-guidelines.md

If we're looking to de-duplicate, can we link out to them? Or is it still better to have these in two different spots?

I'd leaning towards avoiding the duplication, but will give this another look first (I'm not sure how feasible it would be).

(Also, is there a way to embed a .md file in another .md file?)

Not that I know of.

chalin avatar Nov 03 '21 13:11 chalin

Hmm, did y'all (@nate-double-u @celestehorgan) know about https://bestpractices.coreinfrastructure.org/en? There are website requirements as part of their checklist.

chalin avatar Nov 18 '21 10:11 chalin