Plugins

Kanban

Kanban

A Kanban board in docu.nexus is a live view of GitLab issues. It does not store its own cards. Columns are computed from issue fields, and dragging a card writes the change straight back to GitLab.

Which GitLab a board reaches

A board reaches GitLab in one of two ways.

  • No connection (the default): the GitLab people sign in with, as each viewer. If you have not signed in with GitLab and the server has a shared token (OAUTH_GITLAB_SYNC_TOKEN), the board uses that token, so GitLab sees one shared account and everybody it serves sees the same issues. On an instance without GitLab sign-in, that shared token is the only way a board with no connection reaches GitLab. With neither, the board asks you to sign in with GitLab, or says that GitLab sign-in is not set up on this instance.
  • A GitLab connection: one an instance administrator made under Admin -> Connections and allowed in this nexus under Admin -> People & Access -> Connections. One connection can serve any number of boards and Git Docs pages, in as many nexuses as it is allowed in.

A GitLab connection decides whose token a board spends, under Boards act as:

Boards act asWho GitLab sees
Each viewer (the default)Whoever opens the board, with their own GitLab sign-in. This works only when the connection points at the GitLab people sign in with; a sign-in token is never sent to any other server.
This tokenThe connection’s own access token, for everybody. Use it for a GitLab that is not the sign-in one.

A nexus no longer sets its own GitLab URL. If yours had one, Admin -> Kanban says so and offers to forget it; to keep reaching that server, ask an instance administrator for a connection to it.

Pick a board’s connection

Anyone who can edit the board picks its connection: open the Filter menu above the board and choose under GitLab connection. The list holds only the GitLab connections allowed in this nexus, and the first entry is no connection. The picker appears once at least one connection is allowed here.

When a board says Stopped

If an instance administrator withdraws the board’s nexus from its connection, the board keeps the connection and stops fetching. It shows a Stopped chip and says which connection it is waiting for. It resumes by itself when the nexus is allowed again. An editor can also point it at another connection, or at none, from the same message.

The admin tab

Open Admin -> Kanban and pick the nexus under Nexus. The list holds the nexuses you administer.

  • Connection lists the GitLab connections this nexus may use, whose token each makes boards spend, and a Test button for each. It also names the GitLab a board with no connection reaches.
  • Status reports, for a board with no connection, one of Connected as you (GitLab sign-in), Using the shared server token, or Not connected. Test connection opens a throwaway request and reports the GitLab version it reached, and Connect GitLab starts the GitLab sign-in when it is set up on the server.

Create a board

In a space, open the New content menu (the + next to Content in the sidebar) and pick Board. The space rail has the same action.

A board is a page. Rename it by clicking the board name in the header and typing. Enter commits, Escape reverts. Favorite it, watch it, copy its link, or move it to Trash from the right-hand rail.

If you can only view the board, its name is a plain heading, the Filter menu says you cannot change the board’s name, source or default view and offers neither Source, GitLab connection nor Save as default view, and the rail has no Delete board. Searching, filtering and grouping still work for you, and moving or editing a card is up to your GitLab account, as it is for everyone.

Choose a source

Open the Filter menu above the board, then set Source:

SourceWhat it loads
My Work (all projects)Every issue assigned to you across the GitLab instance
Projects…Issues from one or more projects you pick by search
Groups…Issues from one or more groups you pick by search

The source is saved on the board immediately, so the board opens to it every time.

Columns

Columns are not something you create. They are derived from the field you group by, set under Group into columns in the Filter panel:

GroupingColumnsDrag writes
AutoThe scoped label used most on the board (for example priority)The scoped label
A scope name, for example PriorityOne column per value of that scoped label, plus No priorityThe scoped label
State (open / closed)Open and ClosedCloses or reopens the issue
MilestoneOne per milestone, plus No milestoneThe milestone
ProjectOne per projectNothing (read-only)
NoneA single Issues (n) columnNothing (read-only)

Known scopes are ordered sensibly rather than alphabetically, so a status scope reads backlog, todo, doing, review, blocked, done.

Filter and save a view

The same panel carries Search (title, ref, or label), Label, Assignee (including Unassigned), and State (Open, Closed, All). The trigger button shows a badge with the number of active filters. Clear filters resets them.

Save as default view stores the current grouping and filters on the board, so it opens that way for everyone next time.

Cards

Each card shows the project reference and issue number (group/project#42), the title, and up to four label chips. The arrow icon opens the issue in GitLab in a new tab.

Drag a card into another column to move it. The move is optimistic: the card jumps immediately and reverts with an error if GitLab rejects it. A read-only token produces “Your GitLab token is read-only (needs the api scope).”

Click a card to open its detail panel, where you can edit:

  • Title (click to edit)
  • State, via the Open · Close / Closed · Reopen button
  • Milestone
  • Assignees, picked from project members
  • Labels, picked from project labels with a filter box
  • Description, with Write and Preview tabs rendering GitLab markdown
  • Comments, listed with authors, plus a box to add one

Create an issue

Press the + button at the top of the board’s right-hand rail (New issue). Fill in the title, description, labels, assignees and milestone, then press Create issue. On a board scoped to a single project the project is implied; otherwise pick one from the Project dropdown. The new issue appears at the top of the board.

Rail actions

ButtonAction
New issueOpens the create form (only when the board has a project to create in)
Refresh boardRefetches issues from GitLab
Add to favoritesPins the board in your sidebar
Watch for changesSubscribes you to the page
More optionsCopy link, Delete board (moves the page to Trash)