PR#5237: Add some basic documentation for boards - pagure

pagure

#5237 Add some basic documentation for boards

Merged 2 years ago by ngompa. Opened 2 years ago by bcotton.

bcotton/pagure add_board_docs into master

Add some basic documentation for boards

Ben Cotton • 2 years ago

21ff1b3

doc/usage/board.rst

file added

+44

		`@@ -0,0 +1,44 @@`
		`+ Using Boards`
		`+ ============`
		`+`
		+ Pagure provides basic `kanban board <https://en.wikipedia.org/wiki/Kanban_(development)>`_ functionality.
		`+ This allows the state of issues to be represented visually.`
		`+ The feature requires a specific, admin-defined tag to appear on a board.`
		`+ A repository may contain multiple boards, each with a different tag.`
		`+`
		`+`
		`+ Creating a Board`
		`+ ----------------`
		`+`
		+ #. From the ``Settings`` tab, select ``Boards``
		+ #. Click the ``Add a new board`` button
		+ #. Enter a descriptive name in the ``Board name`` text box
		+ #. Select the tag to use in the ``Tag`` drop down
		+ #. Ensure the ``Active`` checkbox is checked
		+ #. Click the ``Update`` button to create the board
		`+`
		`+ After the board is created, add the status columns.`
		`+`
		+ #. While still on the ``Boards`` settings, click the wrench icon button
		+ #. If you want to use the default statuses (``Backlog``, ``Triaged``, ``In Progress``, ``In Review``, ``Done``, ``Blocked``), click the ``Populate with defaults`` button.
		+ #. If you wish to add non-default statuses, click the ``Add new status`` button
		+ #. Enter a name for the status in the ``Status name`` text box
		+ #. If you want this status to be the default for issues added to the board, select the ``Default`` radio button.
		+ #. If you want this status to close the issue, check the ``Close`` check box
		+ #. Select the ``Color`` for the status on the board. This is for visual distinctness; you do not have to change it.
		`+ #. Repeat until all of the desired statuses are added`
		`+ #. Click and drag the arrows to reorder the statuses, if desired.`
		+ #. Click the ``Update`` button when finished.
		`+`
		`+ Using Boards`
		`+ ------------`
		`+`
		`+ To add an issue to a board, add the board's label to the issue.`
		`+ Alternatively, you can add an existing issue to the board by clicking the plus sign on the desired status column and adding the issue number.`
		`+`
		+ To change the status of an issue. go to the ``Boards`` tab and drag the card on the board into the desired status column.
		+ The status appears on the issue under the ``Boards`` information, but it cannot be changed from the issue.
		`+`
		+ If you drag an issue to a column that has the ``Close`` boolean set, Pagure will automatically close the issue.
		`+`
		`+ .. note:: If you close an issue directly, Pagure will remove the board's label.`

doc/usage/index.rst

file modified

		`@@ -59,6 +59,7 @@`
		`upgrade_db`
		`pagure_ci`
		`quick_replies`
		`+ board`
		`troubleshooting`
		`tips_tricks`

doc/usage/project_settings.rst

file modified

		`@@ -30,6 +30,13 @@`
		above is disabled in favor of the `merge` option.


		+ `Boards`
		`+ --------------------------`
		`+`
		`+ The boards feature provides simple kanban board functionality by showing issues in columns that represent state.`
		`+ The settings page lists existing boards and allows adminisrators to add new boards.`
		`+`
		`+`
		`Comment editing`
		`--------------------------`