cfpb / design-manual

⚠️ THIS REPO IS DEPRECATED ⚠️ A set of design principles and standards for the Consumer Financial Protection Bureau.
https://cfpb.github.io/design-manual/
Creative Commons Zero v1.0 Universal
98 stars 71 forks source link

Where will the DM content strategy guidelines live? #404

Closed kurzn closed 7 years ago

kurzn commented 8 years ago

Team proposed creating wiki pages to communicate the content strategy for the DM here:

https://github.com/cfpb/design-manual/wiki

Each navigational "bucket" would have its own page.

We would also link to the wiki pages from the read.me.

Please share if you have a concern with this approach or have a better idea!

marteki commented 8 years ago

Wiki pages can get lost in GitHub repos, even if linked to from the readme. This is even truer if the person looking at the manual isn't a developer, or doesn't work with developers often.

If we go the wiki route, could we also link it to them from the DM Overview page? It'd almost be part of a "how to use the manual" section, and would be more transparent to non-D&D-ers or non-current-contributors who would be looking for guidance on contributing.

Side note: y'all probably already know this, and it's probably out of scope for this sprint, but almost all the content on those wiki pages are out of date. A non-exhaustive list of what I found, for when it's time for the content to be updated:

kurzn commented 8 years ago

@marteki We realize the wiki in GH isn't the most obvious place. However, there is some potential opposition to publishing a link to the guide so publicly on the DM itself. We'll still pursue that route, as it's the best one, but it may not be an option we can implement. Thanks for your feedback and suggestions!