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

Direct link documentation

Open new browser tab and paste url

{JIRA_URL}/secure/ExtenderProjectDocumentation.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

When option Share Project documentation in Extensions Configuration

{JIRA_URL}/secure/ExtenderExtensions.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

Method type - 

URL: {JIRA_URL}/rest/extender/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

• 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 - 

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

2a) Create a new Confluence page

Method type - 

URL: {JIRA_URL}/rest/extender/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 - 

URL: {JIRA_URL}/rest/extender/1.0/confluence/updatePage

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

JavaScript example

Bash example

Update an existing Confluence page

ITSM.json

"applicationId":"641cdf33-1a09-3607-84c7-f79ec1b7a6a5",
"pageId":"171737347",
"pageTitle": "Test documentation",

updatePage.sh

#!/bin/bash

#Variables
PROJECT_KEY='ITSM'
APP_URL='https://my.jira.pl'
APP_AUTH='Authorization:Basic YWRtaW4yOmFkbWluMg=='
CONTENT_JSON='Content-Type: application/json'
NO_TOKEN='X-Atlassian-Token: no-check'

#Get project cofiguration content
CONTENT=`curl --silent -k -H "$APP_AUTH" -H "$NO_TOKEN" $APP_URL'/rest/extender/1.0/documentation/project/'$PROJECT_KEY | jq '.content'`

#Create temporary file for project
echo { > "$PROJECT_KEY"_temp.json
cat "$PROJECT_KEY".json >> "$PROJECT_KEY"_temp.json
echo \"content\":"$CONTENT" >> "$PROJECT_KEY"_temp.json
echo } >> "$PROJECT_KEY"_temp.json

#Update page
curl -X POST -H "$APP_AUTH" -H "$NO_TOKEN" -H "$CONTENT_JSON" -d @"$PROJECT_KEY"_temp.json $APP_URL'/rest/extender/1.0/confluence/updatePage'

#Remove temporary file
rm -rf "$PROJECT_KEY"_temp.json

Troubleshooting

{"statusCode":413,"message":"Request too large. Requests for this resource can be at most 5242880 bytes"}

Exception in request: java.net.SocketTimeoutException: Read timed out in http POST to ...

Example documentation

PDF

Image

Availability