Adding documents

Owned by David Claudia
Last updated: Jun 18, 2024
3 min read

On this page

 

Besides folders, the Documents app supports two document types:

  • File – consists in a file that is uploaded and stored in Jira, plus data about that file like Title or Description.

  • URL – consists in a URL (link) to a remote file or web-page, plus data about that remote file or web-page like Title or Description.

Adding File documents

A File document consists of a file that is uploaded and stored in Jira, along with data about that file like its Title or Description.

image-20240618-083352.png

Follow these steps to add (post) a new document of type File:

  • In Jira, go to Projects.

  • Make sure that you are on the right project.

  • Click the Documents tab of the Jira project and navigate to the folder where you want to add the new document.

  • Click Add > Add File

The Add button is available only if the user has Create permission.

  • Enter a Title (or a name) for your document. This field is mandatory.

  • Optionally, enter a short Description for the document.

  • Attach a File. Use the Choose file button to upload the file. The file that you select cannot exceed the maximum file size configured by the Jira administrator.

  • Optionally, if you use version numbering for your documents, type the current version of the document in the Current Revision field. You can also specify additional information about the current version of the document:
    Revision Date – the date when the version of the added document was created.
    Revision Author(s) – the name of the person(s) who created the version of the added document.
    Revision Notes – a short description of the changes made to the version of the added document.

  • Click Create. If all the required fields were properly completed, the document is added and displayed in the Documents table. A message with the result of this action will pop up at the top of the page.

Adding URL documents

A URL document consists of a URL (link) to a remote file or web page and data about that remote file or web page, like Title or Description.

image-20240618-083401.png

Follow these steps to add (post) a new document of type URL:

  • In Jira, go to Projects.

  • Make sure that you are on the right project.

  • Click the Documents tab of the Jira project and navigate to the folder where you want to add the new document.

  • Click Add > Add URL

The Add button is available only if the user has Create permission.

  • Enter a Title (or a name) for your document. This field is mandatory.

  • Optionally, enter a short Description for the document.

  • Specify the URL of the document. The URL that you specify must include the protocol ("http://", "https://", "ftp://" or "file:").

For security reasons, most browsers do not allow opening links of the type "file:". This means that you will not be able to open the file by clicking the links available on the Documents tab. Be aware of this limitation when using URLs of the type "file:"!

  • Optionally, if you use version numbering for your documents, type the current version of the document in the Current Revision field. You can also specify additional information about the current version of the document:
    Revision Date – the date when the version of the added document was created.
    Revision Author(s) – the name of the person(s) who created the version of the added document.
    Revision Notes – a short description of the changes made to the version of the added document.

  • Click Create. If all the required fields were properly completed, the document is added and displayed in the Documents table. A message with the result of this action will pop up at the top of the page.