search

nikku / wuffle

A multi-repository / multi-organization task board for GitHub issues.
https://wuffle.dev
MIT License
118 stars 23 forks source link

Setup Notes for Deployed Application #36

Closed joannenolan-sky closed 5 years ago

joannenolan-sky commented 5 years ago

Here are the detailed setup notes that I have created for my team including screenshots and examples

nikku commented 5 years ago

Thanks for your PR.

I had an improved getting started in my backlog for quite a while and came up with something. If you put yourself in your co-workers shoes, is this something they could work with? Or should we merge additional bits from your tutorial / docs?

joannenolan-sky commented 5 years ago

I think it would be good to include the permissions section as this has caused us issues in the past. Also maybe a section about re-copying the Webhook secret if you see the signature mismatch error.

Just remembered another thing: the columns In Progress, Needs Review, and Done cannot be renamed as they are hard-coded into the automatic dev flow. Also if there is no column with label: null all issues will be put into the first column regardless of label

nikku commented 5 years ago

I think it would be good to include the permissions section as this has caused us issues in the past. Also maybe a section about re-copying the Webhook secret if you see the signature mismatch error.

A TROUBLESHOOTING document could be a good place for these two issues.

Just remembered another thing: the columns In Progress, Needs Review, and Done cannot be renamed as they are hard-coded into the automatic dev flow. Also if there is no column with label: null all issues will be put into the first column regardless of label

This sounds like a good target for better validation (https://github.com/nikku/wuffle/issues/39). I'll probably rather implement validation than putting that in to a distinct document.

joannenolan-sky commented 5 years ago

yeah that sounds like a good plan.

Just another quick one for the validation. If you run npm run all locally, it will use your local wuffle-config.js and fails if it is not using the default columns

nikku commented 5 years ago

Another one for a TROUBLESHOOTING document: https://github.com/nikku/wuffle/issues/43

Users must configure the appropritate login callback url.

nikku commented 5 years ago

Just another quick one for the validation. If you run npm run all locally, it will use your local wuffle-config.js and fails if it is not using the default columns

This is not the case anymore.

nikku commented 5 years ago

I've created the TROUBLESHOOTING document I've talked about: https://github.com/nikku/wuffle/blob/master/docs/TROUBLESHOOTING.md

Along with the vastly improved startup validation this should give users enough hints to know where to continue.

nikku commented 5 years ago

Note that your setup instructions are outdated: As of v0.16.0 specifying repositories is no longer necessary, you control repository apperance on the board entirely via GitHub app installation.