Guide on how to create your own Design Principles

[benbrignell]

work in progress

[MattGreyDesign]

I would suggest looking into https://staticman.net/. It might be possible to make a form on the site that allows the creation of example pull requests without having to go through the Github interface or CI.

[benbrignell]

This (rather vaguely described) ticket is for a page I'm working on which is to help people create their own principles for their own teams and suggestions on how to do workshops etc to achieve this. (Mostly found via the /create page)

Thanks @MattGreyDesign for all your recent comments and contributions! What it looks like you're commenting on is something I want to improve - which is submitting examples of principles. I have looked at https://staticman.net/ before and it's great you're thinking about the workflow for submissions. (Although there have been a surprisingly large amount of PRs the last week!)

One issue I have with this and similar tools is I think GitHub only grants one level of authorisation which requires read permissions for all repos including private. You can't choose which repos it works with. While this service doesn't use them I've some repos which contractually do not permit access from other parties. But I'll take a look in more detail. Maybe I can move and reorganise a few private repos and use this.

I know @bradfrost used a submission form on http://styleguides.io/add which is also a method to consider.

There's a bit of formatting needed for each submission, I was thinking of making a simple tool on the site where you enter the URL, author, add a principle, add a summary… etc and then it generates a formatted markdown file which you can submit via form (or paste into GH).

A form-based tool via static man would be great, I'll take a look in more detail over the weekend, thanks Matt!

[MattGreyDesign]

Yeah sorry I know it wasn't completely the same functionality, but wondered if it might work for that as well and class as a submission.

It was my understanding that you could connect Staticman exclusively to the repo as a collaborator without having it connected to any other repos. Anywho, it was only a suggestion to explore if you hadn't come across it before, not sure it would necessarily fit the use-case but yep it's an idea.

I have a similar collaborative static site I'm starting to build out that has the same submission process, and I'm hoping to use Staticman to "Web 2.0" it and automate the process because I'm currently manually adding the hundreds of posts 😱