Update Jira article

This commit is contained in:
Svetlana Maleeva 2022-11-17 17:54:13 +03:00
parent b0f421e902
commit b5172abb11
18 changed files with 79 additions and 17 deletions

View File

@ -62,11 +62,12 @@
<h3>Main features</h3>
<div class="PortalHelp">
<ul>
<li>Viewing and editing text documents, spreadsheets, presentations, and forms using the <b>Edit in ONLYOFFICE</b> option.
<div class="notehelp">To learn more about forms please read the corresponding articles for <a href="https://helpcenter.onlyoffice.com/onlyoffice-editors/onlyoffice-document-editor/UsageInstructions/CreateFillableForms.aspx">creating</a> and <a href="https://helpcenter.onlyoffice.com/onlyoffice-editors/onlyoffice-document-editor/UsageInstructions/FillingOutForm.aspx">filling out</a> forms.</div>
</li>
<li>Co-editing documents in real-time: two co-editing modes (Fast and Strict), Track Changes, comments, and a built-in chat.</li>
<li><b>JWT support</b> to secure your traffic so that no one can have access to your documents with the exception of the users with proper rights.</li>
<li>Creating new documents, spreadsheets, presentations, and forms.</li>
<li>Viewing and editing text documents, spreadsheets, presentations, and forms using the <b>Edit in ONLYOFFICE</b> option.
<div class="notehelp">To learn more about forms please read the corresponding articles for <a href="https://helpcenter.onlyoffice.com/onlyoffice-editors/onlyoffice-document-editor/UsageInstructions/CreateFillableForms.aspx">creating</a> and <a href="https://helpcenter.onlyoffice.com/onlyoffice-editors/onlyoffice-document-editor/UsageInstructions/FillingOutForm.aspx">filling out</a> forms.</div>
</li>
<li>Co-editing documents in real-time: two co-editing modes (Fast and Strict), Track Changes, comments, and a built-in chat.</li>
<li><b>JWT support</b> to secure your traffic so that no one can have access to your documents with the exception of the users with proper rights.</li>
</ul>
</div>
</div>
@ -93,15 +94,16 @@
<h3>Requirements</h3>
<p></p>
<ul>
<li>ONLYOFFICE Docs 6.4.0 or higher
<p>You need an instance of ONLYOFFICE Docs that is resolvable and connectable both from Jira and any end clients. It must be able to POST to Jira directly.</p>
<div class="notehelp">
Please refer to the official <a href="https://helpcenter.onlyoffice.com/installation/docs-index.aspx" target="_blank"><b>ONLYOFFICE Docs documentation page</b></a> to learn more about installing ONLYOFFICE Docs.
</div>
</li>
<li>Jira Software (Server or Data Center) v. 7.13.0 - 8.19.0
<p>Please refer to the official <a href="https://confluence.atlassian.com/adminjiraserver/installing-jira-applications-938846823.html" target="_blank"><b>Atlassian documentation</b></a> to learn more about installing Jira Software.</p>
</li>
<li>ONLYOFFICE Docs 6.4.0 or higher
<p>You need an instance of ONLYOFFICE Docs that is resolvable and connectable both from Jira and any end clients. It must be able to POST to Jira directly.</p>
<div class="notehelp">
Please refer to the official <a href="https://helpcenter.onlyoffice.com/installation/docs-index.aspx" target="_blank"><b>ONLYOFFICE Docs documentation page</b></a> to learn more about installing ONLYOFFICE Docs.
</div>
</li>
<li>Jira Software (Server or Data Center) v. 9.0.0 - 9.3.1
<p>Please refer to the official <a href="https://confluence.atlassian.com/adminjiraserver/installing-jira-applications-938846823.html" target="_blank"><b>Atlassian documentation</b></a> to learn more about installing Jira Software.</p>
</li>
<li>ONLYOFFICE connector v2.1.0 and later for Jira</li>
</ul>
</div>
</div>
@ -175,6 +177,7 @@
<img alt="ONLYOFFICE_connector" id="ONLYOFFICE_connector_4" class="bigphoto_screen" src="/images/help/GettingStarted/Integration/Jira/big/settings.png" />
<div target="ONLYOFFICE_connector_4" class="screenphoto magnifier"></div>
</div>
<p><b>Disable certificate verification (insecure)</b> - check this box to disable the certificate verification and allow Jira to establish connection with ONLYOFFICE Docs if you are using a self-signed certificate for your ONLYOFFICE Docs (otherwise, Jira will not validate a self-signed certificate and will not allow for connection to/from ONLYOFFICE Docs). This is an insecure solution, and we strongly recommend that you replace the certificate with the one issued by some CA.</p>
<p>Specify a <b>Secret key</b> - the secret to validate the JSON web token upon the request to ONLYOFFICE Docs.</p>
<div class="notehelp">Starting from ONLYOFFICE Docs <b>v7.2</b>, JWT is enabled by default and the secret key is generated automatically. You need to enable it on the Jira side as well: find your secret key in the ONLYOFFICE Docs configuration file, then specify the same secret key in the connector settings. For more details, see the <a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-jira.aspx#JWT_block")%>">Enabling JWT for the ONLYOFFICE and Jira integration</a> section of this article.</div>
<p>The <b>Advanced server settings</b> section can be used if your network configuration does not allow for requests between the installed Jira Software and ONLYOFFICE Docs using the public addresses. In this case, specify addresses for internal requests in the corresponding fields:</p>
@ -252,25 +255,45 @@
<p>In the connector settings, specify the same secret in the <b>Secret key</b> field and save the settings.</p>
</div>
<div class="gs_content gs_submenu" id="Demo_block">
<h3>Connecting to the demo ONLYOFFICE Docs</h3>
<p>Starting from <a href="https://github.com/ONLYOFFICE/onlyoffice-jira/releases/tag/2.0.0" target="_blank"><b>ONLYOFFICE connector version 2.0.0</b></a>, you can try the ONLYOFFICE online editors within Jira without installing ONLYOFFICE Docs.</p>
<p>To turn the connection on, click the <b>Connect to demo ONLYOFFICE Docs server</b> checkbox and click the <b>Save</b> button.</p>
<div class="notehelp">This is a public test server that will be available during a 30-day period. Dont share your sensitive data there.</div>
</div>
</div>
</div>
<div class="gs_content" id="StartUsing_block">
<h2>Start using ONLYOFFICE Docs within Jira</h2>
<h3>Viewing and editing files</h3>
<h3>Creating, viewing and editing files</h3>
<div class="PortalHelp">
<p>You can open the ONLYOFFICE editors from any <b>Attachments</b> block of an issue. This option is available for issues from any module where an issue can be opened, e.g., issue list, backlog, issues, etc.</p>
<div class="notehelp">
Attachments must be <a href="https://support.atlassian.com/jira-cloud-administration/docs/configure-file-attachments/" target="_blank"><b>enabled by the administrator</b></a>.
<p>A new attachment can be added on the issue page using the <b>More</b> -> <b>Attach files</b> option. To learn more, see the <a href="https://confluence.atlassian.com/jiracoreserver/attaching-files-and-screenshots-to-issues-939937892.html" target="_blank"><b>official documentation</b></a>.</p>
</div>
<p>To open a text document, spreadsheet, presentation, or form, move the mouse pointer over the necessary file and click the <img alt="ONLYOFFICE_connector" src="/images/help/GettingStarted/Integration/Jira/small/onlyoffice_icon.png" /> <b>Edit in ONLYOFFICE</b> icon.</p>
<p>To open an existing text document, spreadsheet, presentation, or form, move the mouse pointer over the necessary file and click the <img alt="ONLYOFFICE_connector" src="/images/help/GettingStarted/Integration/Jira/small/onlyoffice_icon.png" /> <b>Edit in ONLYOFFICE</b> icon. If the <a href="#Overview_block"><b>file format</b></a> is not supported for editing, the <b>View in ONLYOFFICE</b> option is available. For the <b>.oform</b> files, the <b>Fill in form in ONLYOFFICE</b> option is available.</p>
<div class="screen_block">
<img alt="ONLYOFFICE_connector" target="ONLYOFFICE_connector_5" class="screenphoto screen_guides" src="/images/help/GettingStarted/Integration/Jira/small/attachment.png" />
<img alt="ONLYOFFICE_connector" id="ONLYOFFICE_connector_5" class="bigphoto_screen" src="/images/help/GettingStarted/Integration/Jira/big/attachment.png" />
<div target="ONLYOFFICE_connector_5" class="screenphoto magnifier"></div>
</div>
<p>The file will be opened in a new browser tab in the corresponding ONLYOFFICE editor.</p>
<p>The file will be opened in a new browser tab in the corresponding ONLYOFFICE editor.</p>
<p>To create a new file using the ONLYOFFICE editors:</p>
<ol>
<li>In the <b>Attachments</b> block of an issue, click the <b>Create file with ONLYOFFICE</b> option.</li>
<li>Choose the needed file type: Document, Spreadsheet, Presentation, or Form template.</li>
<li>Type in the file name and click <b>Create</b>.
<div class="screen_block">
<img alt="Create file" target="create" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/small/create.png")%>" />
<img alt="create" id="create" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/big/create.png")%>" />
<div target="create" class="screenphoto magnifier"></div>
</div>
</li>
<li>The file will be opened in a new browser tab in the corresponding ONLYOFFICE editor.</li>
</ol>
</div>
<h3>Access permissions</h3>
@ -280,6 +303,27 @@
<p><b>Viewing files</b>. File preview in the ONLYOFFICE viewers is available for all users who can view an issue, but do not have permissions for editing the issue <b>or</b> permissions for creating attachments. If the <a href="#Overview_block"><b>file format</b></a> is not supported for editing, the file will be opened for viewing.</p>
</div>
<h3>Converting documents</h3>
<p>To convert a document to the Office Open XML format:</p>
<ol>
<li>Move the mouse pointer over the necessary file and click the <img alt="ONLYOFFICE_connector" src="/images/help/GettingStarted/Integration/Jira/small/converticon.png" /> <b>ONLYOFFICE conversion service</b> icon.
<div class="screen_block">
<img alt="Convert" target="convert" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/small/conversion.png")%>" />
<img alt="Convert" id="convert" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/big/conversion.png")%>" />
<div target="convert" class="screenphoto magnifier"></div>
</div>
</li>
<li>Optionally, you can change the file name.</li>
<li>Click the <b>Convert</b> button.</li>
<li>The converted file will be stored in the <b>Attachments</b> block.
<div class="screen_block">
<img alt="Convert" target="convert2" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/small/conversionresult.png")%>" />
<img alt="Convert" id="convert2" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/big/conversionresult.png")%>" />
<div target="convert2" class="screenphoto magnifier"></div>
</div>
</li>
</ol>
<h3>Saving changes</h3>
<div class="PortalHelp">
<p>The changes made to a file are saved to a new file with the same name as the original file, with a postfix added at the end of the file name, e.g. <code>Sample-1.docx</code>.</p>
@ -290,5 +334,23 @@
</div>
<p>The changes made to a file during the co-editing process are only saved to the first version of the file. If the document is being edited by several users simultaneously, the changes will be displayed only in the first file. Until the last user closes the editor, a new version of the file is not added to the issue.</p>
</div>
<h3>Downloading files</h3>
<div class="PortalHelp">
<p>To download a document in a different format:</p>
<ol>
<li>Move the mouse pointer over the necessary file and click the <img alt="ONLYOFFICE_connector" src="/images/help/GettingStarted/Integration/Jira/small/converticon.png" /> <b>ONLYOFFICE conversion service</b> icon.
<div class="screen_block">
<img alt="Download" target="download" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/small/download.png")%>" />
<img alt="Download" id="download" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Jira/big/download.png")%>" />
<div target="download" class="screenphoto magnifier"></div>
</div>
</li>
<li>Optionally, you can change the file name.</li>
<li>Select the necessary format from the <b>Target type</b> list.</li>
<li>Click the <b>Download</b> button.</li>
<li>The downloaded file will be stored on your computer.</li>
</ol>
</div>
</div>
</div>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 983 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 20 KiB