Project Documentation for Jira

Automatically generate complete Jira project documentation containing all necessary information

 

General information

How many times have you tried to check or create full project documentation? How many times have you modified the project and forgot to update the documentation ?. Project documentation allows you to generate a complete project documentation containing all information such as schema configuration, components, versions, custom fields, but also everything related to Jira Service Management such as queues, request types, SLAs, etc.

… and you can do it with one click in Jira

 

Where you can generate Project documentation

Documentation is available for each project in Project Settings by clicking the Project Documentation link and on the left sidebar of the project

 


Open new browser tab and paste url

{JIRA_URL}/secure/ProjectDocumentation.jspa?projectKey={PROJECT_KEY}where:

{PROJECT_KEY} - Project key

 


Change documentation view

You can do this using the configuration from the GUI (just click the icon in the top right corner) where you have an additional choice regarding some configuration items.

Additionally, you can save a new view as default for documentation.

 


Share documentation with project administrators

Before making this option available, check if users should see the details of this full configuration

When option Share Project documentation in Project Documentation Configuration

{JIRA_URL}/secure/ProjectDocumentationConfiguration.jspa

is enabled, all users who have the right to administer the project will see the new section in the project settings and will have the right to view the full documentation of the project.

 


Export to Confluence

Directly form project documentation in Jira you can export documentation to Confluence.

Click the Export button and select the space/page where you want to export the documentation, after this operation all your information about the project will be in Confluence so you can easily maintain and search the documentation.

 

Automation

Project documentation in Confluence can be automated at your discretion so that it is refreshed from time to time. there are two dedicated APIs for this, which in combination can create/update a page.

1) Get Confluence content for project

Api returns the appropriate documentation format for Confluence

Method type - GET

URL: {JIRA_URL}/rest/project-documentation/1.0/documentation/project/PROJECT_KEY

In addition, you can control which sections will be hidden in the API response regarding project documentation, just add a dedicated parameter:

  • hideIssueTypes=true

  • hidePriorities=true

  • hideWorkflows=true

  • hideAutomation=true

  • hideWorkflowSchemes=true

  • hideIssueTypeScreens=true

  • hideScreenSchemes=true

  • hideScreens=true

  • hideOrganizations=true

  • hideFields=true

  • hideFieldContextConfigurations=true

  • hideFieldConfigurationSchemes=true

  • hideFieldConfigurations=true

  • hidePermissions=true

  • hideIssueSecurity=true

  • hideNotifications=true

  • hideVersions=true

  • hideComponents=true

  • hideRoles=true

  • hideRequestTypes=true

  • hideKnowledgeBase=true

  • hideSLAs=true

  • hideCalendars=true

  • hideQueues=true

  • hideLanguageSupport=true

  • hideEmailRequests=true

  • hideCustomerNotifications=true

Example:

Method type - GET

URL: {JIRA_URL}/rest/project-documentation/1.0/documentation/project/PROJECT_KEY?hideEmailRequests=true&hideCustomerNotifications=true

2a) Create a new Confluence page

Method type - POST

URL: {JIRA_URL}/rest/project-documentation/1.0/confluence/createNewPage

{ "applicationId": "APPLICATION_ID" "content": "CONTENT_FROM_STEP_1" "pageTitle": "PAGE_TITLE" "parentPageId": "PARENT_PAGE_ID" "spaceKey": "SPACE_KEY" }

2b) Update an existing Confluence page

Method type - POST

URL: {JIRA_URL}/rest/project-documentation/1.0/confluence/updatePage

{ "applicationId": "APPLICATION_ID" "content": "CONTENT_FROM_STEP_1" "pageTitle": "PAGE_TITLE" "pageId": "PAGE_ID" }

JavaScript example

Update an existing Confluence page

//Get project content $.ajax({ "url": "http://my.jira.pl/rest/project-documentation/1.0/documentation/project/ITSM", "headers": { "Authorization": "Basic YWRtaW46YWRtaW4=" } }).done(function (responseContent) { //Update page $.ajax({ "method": "POST", "url": "http://my.jira.pl/rest/project-documentation/1.0/confluence/updatePage", "headers": { "Authorization": "Basic YWRtaW46YWRtaW4=", "Content-Type": "application/json" }, "data": JSON.stringify({ "applicationId": "76888b66-b3e3-3eb2-bbdc-34d51bd6c884", "content": responseContent.content, "pageId": "819203", "pageTitle": "Test doc 2" }) }).done(function (response) { console.log("DONE !!!") }); });

Create a new Confluence page

Bash example

Update an existing Confluence page

This example need two files in the same location

ITSM.json

updatePage.sh

 

Troubleshooting

Problem

Resolution

Problem

Resolution

When making a REST call to Confluence the console gives the error

https://confluence.atlassian.com/confkb/rest-call-gives-request-too-large-requests-for-this-resource-can-be-at-most-5242880-bytes-error-939689514.html

When a Jira instance makes an HTTP request to a remote server, the request fails with a message similar to

https://confluence.atlassian.com/jirakb/java-net-sockettimeoutexception-read-timed-while-making-a-request-to-a-remote-server-788958227.html

 


Example documentation

PDF

Confluence

 

 

 

Jira

 

 

About plugin

This app includes the following libraries:

  • html2canvas - MIT License - Copyright (c) 2021 Niklas von Hertzen