Trello
Each note raised becomes a card on one Trello board. Moving the card to your Done list, or archiving it, marks the note done; moving it back out opens the note again.
Before starting, do steps 1 and 2 of How connections work: data-issues="queue" on the tag, and a secret on the store.
1Get an API key
Trello hands out keys through its Power-Up page. You do not need to build a Power-Up; the form is just how the key is issued.
- Open trello.com/power-ups/admin and press New.
- Fill in the form: name
Notefix, your Workspace, your email and your name. Press Create. - On the page that opens, go to API key and press Generate a new API key.
- Copy the API key. You do not need the secret.
2Get a token
The token lets Notefix act on your boards. Copy this address, put your key in place of YOUR_KEY, and open it:
https://trello.com/1/authorize?expiration=never&name=Notefix&scope=read,write&response_type=token&key=YOUR_KEYPress Allow. Trello shows the token on the next page: copy it.
A Trello token can do anything its account can, on every board the account is on. For real use, make a separate Trello account that is only a member of the board under review, and create the token signed in as that account.
3Get the board ready
The board needs:
- A list for new cards. The first list on the board, unless you choose another.
- A list that means finished, called
Done, or another name you choose. A card moved there closes its note.
4Write the settings file
On the server where the store runs:
sudo mkdir -p /etc/notefix
sudo install -m 600 -o "$USER" /dev/null /etc/notefix/trello.env
nano /etc/notefix/trello.envNOTEFIX_API=http://127.0.0.1:8097
NOTEFIX_BOARD=staging
NOTEFIX_SECRET=the-secret-you-gave-the-store
NOTEFIX_SITE=https://staging.acme.com
TRELLO_KEY=paste-your-key
TRELLO_TOKEN=paste-your-token
TRELLO_BOARD="Website review"| Setting | |
|---|---|
TRELLO_BOARD | The board's name, as it appears in Trello. In quotes if it has spaces |
TRELLO_LIST | Optional. The list new cards go in. The first list if left out |
TRELLO_DONE_LISTS | Optional. The lists that mean finished, separated by commas. Done if left out |
5Try it
set -a; . /etc/notefix/trello.env; set +a
python3 connectors/runner.py trelloIt checks the key, the token, the board and its lists first, then says:
trello connector on board 'staging' via http://127.0.0.1:8097On your page, open a note and press Create an issue. Within about 15 seconds the note shows Card #1, and the card is at the top of the list. Drag it to Done, and within a minute the note turns green.
In Settings, under Connected tools, Trello now shows your board and Working.
Then run it as a service, with trello.env and runner.py trello.
What the card looks like#
- Title: the first line of the note.
- Description: the note's words, who wrote it, the screen, the device and the element, and a link back to the page. Then, for developers: the selector, route and build.
- Screenshots from the note are attached to the card.
If it does not work#
| The connector says | What to do |
|---|---|
Trello rejected the key or token | Copied wrong, or the token was revoked. A token made with expiration=30days stops after 30 days |
No open board called 'X'. This token can see: … | Use one of the names it lists, or add the token's account to the board |
None of the lists 'Done' is on the board | Add a Done list, or set TRELLO_DONE_LISTS to the name of yours |
No list called 'X' on the board | Check TRELLO_LIST against the names it lists |
New cards would go straight into a Done list | Set TRELLO_LIST to a list that is not a Done list |