Skip to content

Commit

Permalink
Deployed 4333d79 with MkDocs version: 1.4.2
Browse files Browse the repository at this point in the history
  • Loading branch information
simonhbor committed Aug 15, 2023
1 parent 65d2717 commit b87d66f
Show file tree
Hide file tree
Showing 53 changed files with 471 additions and 253 deletions.
200 changes: 185 additions & 15 deletions External-Bug-Tracking-Integration/Using-Spira-with-GitHub/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5511,7 +5511,7 @@ <h2 id="using-the-jira-cloud-connector">Using the Jira Cloud Connector<a class="
<ol>
<li>Log into your Jira instance as an admin.</li>
<li>Click the admin dropdown and choose Add-ons. The Find new apps or Find new add-ons screen loads.</li>
<li>Locate SpiraPlan app for Jira.</li>
<li>Locate the "SpiraTest" app for Jira.</li>
<li>Click Install to download and install your app.</li>
<li>Click Close in the "Installed and ready to go" dialog.</li>
<li>Now you need to configure the add-on to connect to your SpiraPlan instance.</li>
Expand All @@ -5522,7 +5522,7 @@ <h2 id="using-the-jira-cloud-connector">Using the Jira Cloud Connector<a class="
<li><strong>SpiraPlan URL</strong>: this needs to be the base URL for your SpiraPlan instance, typically of the form:</li>
<li><a href="https://mysite.spiraservice.net">https://mysite.spiraservice.net</a></li>
<li><a href="https://demo.spiraservice.net/mysite">https://demo.spiraservice.net/mysite</a></li>
<li><strong>Username</strong>: This is the login you use to connect to SpiraPlan </li>
<li><strong>Username</strong>: This is the login you use to connect to SpiraPlan (set this to a user who only has read-only permissions so that they are not able to write to any product or part of your Spira instance)</li>
<li><strong>API Key / RSS Token</strong>: This is the RSS Token / API key for the user name you specified.</li>
</ul>
<p>You can get the SpiraPlan API Key from within the User Profile screen of SpiraPlan :</p>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions HowTo-Guides/Integrations-Troubleshoot/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1174,6 +1174,13 @@
How to setup the Jira syncing integration
</a>

</li>

<li class="md-nav__item">
<a href="#how-to-configure-the-cloud-data-sync-service" class="md-nav__link">
How to configure the cloud data sync service
</a>

</li>

</ul>
Expand Down Expand Up @@ -4434,6 +4441,13 @@
How to setup the Jira syncing integration
</a>

</li>

<li class="md-nav__item">
<a href="#how-to-configure-the-cloud-data-sync-service" class="md-nav__link">
How to configure the cloud data sync service
</a>

</li>

</ul>
Expand All @@ -4459,6 +4473,19 @@ <h2 class="section-break" id="how-to-setup-the-jira-syncing-integration">How to
<li>Next, you will need to setup the <a href="../../External-Bug-Tracking-Integration/Setting-up-Data-Synchronization/#spira-external-tool-cloud-hosted">datasync service</a> </li>
<li>Then you will have to set up <a href="../../External-Bug-Tracking-Integration/Using-SpiraTeam-with-Jira-Cloud/">everything in Spira</a> to make sure the right products are syncing in the right way to between Jira and Spira</li>
</ul>
<h2 class="section-break" id="how-to-configure-the-cloud-data-sync-service">How to configure the cloud data sync service<a class="headerlink" href="#how-to-configure-the-cloud-data-sync-service" title="Permanent link">&para;</a></h2>
<p>For cloud-hosted Spira instances you can use Inflectra's cloud data sync to simplify how you sync with third party providers like Jira. To configure a cloud data sync:</p>
<ul>
<li>go to your Customer Area on the Inflectra website, inflectra.com: 'Login' &gt; Customer Area</li>
<li>From there click on "My Cloud Subscriptions" &gt; [Spira]</li>
<li>
<p>Configure the username to use for the dataSync</p>
<ul>
<li>we strongly recommend creating a dedicated user in Spira for this to aid troubleshooting</li>
<li>make sure this user has the role of "Product Owner" for all products that you want to sync with the third party service</li>
</ul>
</li>
</ul>



Expand Down
2 changes: 2 additions & 0 deletions HowTo-Guides/Login-providers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4696,6 +4696,8 @@ <h2 id="okta">Okta<a class="headerlink" href="#okta" title="Permanent link">&par
<li>Token URL:        https://<span authServerId="authServerId" class="arithmatex"><span class="MathJax_Preview">{yourOktaDomain}/oauth2/</span><script type="math/tex">{yourOktaDomain}/oauth2/</script></span>/v1/token</li>
<li>Profile URL:       https://<span authServerId="authServerId" class="arithmatex"><span class="MathJax_Preview">{yourOktaDomain}/oauth2/</span><script type="math/tex">{yourOktaDomain}/oauth2/</script></span>/v1/userinfo</li>
</ul>
<p>The Redirect URI (or return URL) can be found at the bottom of the Okta administration page in Spira.</p>
<p><img alt="" src="../img/LoginProviders-Okta.png" /></p>
<h2 id="onelogin">OneLogin<a class="headerlink" href="#onelogin" title="Permanent link">&para;</a></h2>
<p>First create the application in OneLogin</p>
<ol>
Expand Down
Binary file added HowTo-Guides/img/LoginProviders-Okta.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions Reporting/Custom-Report-Tables/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9047,6 +9047,9 @@ <h2 id="test-run-incidents">Test Run Incidents<a class="headerlink" href="#test-
</thead>
<tbody>
<tr>
<td>TEST_RUN_ID</td>
</tr>
<tr>
<td>INCIDENT_ID</td>
</tr>
<tr>
Expand Down
26 changes: 12 additions & 14 deletions Spira-Administration-Guide/Installing-SpiraPlan/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1353,8 +1353,8 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#install-the-net-framework-v46-v47" class="md-nav__link">
Install the .NET Framework v4.6, v4.7
<a href="#install-the-net-framework-v46-v47-v48" class="md-nav__link">
Install the .NET Framework v4.6, v4.7, v4.8
</a>

</li>
Expand Down Expand Up @@ -4651,8 +4651,8 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#install-the-net-framework-v46-v47" class="md-nav__link">
Install the .NET Framework v4.6, v4.7
<a href="#install-the-net-framework-v46-v47-v48" class="md-nav__link">
Install the .NET Framework v4.6, v4.7, v4.8
</a>

</li>
Expand Down Expand Up @@ -4938,7 +4938,7 @@ <h2 id="system-prerequisites">System Prerequisites<a class="headerlink" href="#s
<li>Ensure that IIS is installed</li>
<li>Ensure that ASP.NET 4.7.2 is enabled</li>
</ul>
<h3 id="install-the-net-framework-v46-v47">Install the .NET Framework v4.6, v4.7<a class="headerlink" href="#install-the-net-framework-v46-v47" title="Permanent link">&para;</a></h3>
<h3 id="install-the-net-framework-v46-v47-v48">Install the .NET Framework v4.6, v4.7, v4.8<a class="headerlink" href="#install-the-net-framework-v46-v47-v48" title="Permanent link">&para;</a></h3>
<p>On most modern Windows 11 and Windows Server 2022+ installations, Microsoft .NET Framework v4.7.2 is usually already installed. On earlier operating systems, you may need to manually add the .NET 4.7.2 components to the factory configuration.</p>
<p>To see which version of the Microsoft .NET framework installed please follow the below steps:</p>
<ul>
Expand Down Expand Up @@ -5147,7 +5147,9 @@ <h3 id="connect-to-the-database">Connect to the Database<a class="headerlink" hr
<p>This is the easiest option when the application and database will be residing on the <em>same</em> server. It is the only option available for authentication during a standard installation. In this case, choose the "Windows Authentication" option and the Login/Password boxes will be disabled. In this case, the installer will connect to the database using your current Windows login to create the application database objects, and SpiraPlan<sup>®</sup> will connect to the database during normal operation using either the ASPNET or NETWORK SERVICE Windows accounts (it depends on the version of the operating system).</p>
<p><strong>b) SQL Server Authentication (advanced mode only)</strong></p>
<p>This is the easiest option when the application and databases will be residing on <em>different</em> servers across the network. In this case, choose "SQL Server Authentication" under "Connection Information" section and provide SQL Server Login that has <strong>full sysadmin</strong> permissions -- e.g. the built in System Administrator (SA) account. The installer will use this SysAdmin account to create the database objects. The password for SA account is set in SQL Server itself and should be saved carefully.</p>
<p>Note that using this account under the 'Connection Info' part of the installer is not a security risk, as the installer does not remember this login and after the database is created, it's never used again. With SQL Server authentication, the IIS application pool will run as a low-credentialed system user, typically the 'NETWORK SERVICE' account. This lets the application pool access the local system resources only. User listed under "Database Settings" for SpiraPlan<sup>®</sup> will use a special login (called "SpiraPlan" by default, created automatically) for normal application operations. The username should not be changed as it is used by the application to operate.</p>
<p>Note that using this account for the 'Connection Info' fields is not a security risk as the installer does not remember this login and after the database is created. The credentials are used once and discarded.</p>
<p>With SQL Server authentication, the IIS application pool will run as a low-credentialed system user, typically the 'NETWORK SERVICE' account. This lets the application pool access the local system resources only:</p>
<p>Inside SQL Server SpiraPlan will use a dedicated login (called "SpiraPlan" by default, created automatically) for normal application operations. The username should not be changed as it is required by the application for it to operate.</p>
<p><strong>Setting the Correct Server Instance</strong></p>
<p>In the "Server" box, you need to enter the name of the Microsoft SQL Server instance that is running on your system; the installer will default it to the hostname of the server (which in many cases will be correct). The easiest way to find out the database server name is to:</p>
<ul>
Expand Down Expand Up @@ -5197,7 +5199,7 @@ <h3 id="upgrade-location">Upgrade location<a class="headerlink" href="#upgrade-l
<p>In case of problems, a backup of the existing database is made when upgrading. The backup can be manually selected to ensure safety of the current database. The location is given on the summary screen, and is usually the default backup directory for SQL Server. </p>
<p><img alt="" src="../img/Installing_SpiraPlan_23_1.png" /></p>
<p>To recover your system, restore the backup over top of the existing corrupted database. You can then try the upgrade again.</p>
<p>If problems persist, contact the Inflectra support team, and they will explain how to retrieve the logs for remediation.</p>
<p>If problems persist, please contact the Inflectra support team, and they will explain how to retrieve the logs for remediation.</p>
<h2 id="advanced-install-scenarios">Advanced Install Scenarios<a class="headerlink" href="#advanced-install-scenarios" title="Permanent link">&para;</a></h2>
<p>There may be a few cases where you need to customize the installation or upgrade of SpiraPlan<sup>®</sup>. To enable the installer's advanced mode, make sure to check the "Advanced" checkbox at the relevant screen of the wizard.</p>
<p>Including the options listed above with "(advanced mode only)" next to them, Advanced mode lets you:</p>
Expand All @@ -5210,13 +5212,9 @@ <h2 id="advanced-install-scenarios">Advanced Install Scenarios<a class="headerli
</ul>
<p><img alt="" src="../img/Installing_SpiraPlan_advanced-options.png" /></p>
<h3 id="sql-server-authentication-details">SQL Server authentication details<a class="headerlink" href="#sql-server-authentication-details" title="Permanent link">&para;</a></h3>
<p>Without a UserId/password listed in your connection string, Windows Authentication is used (the default). There are two different users to consider here:</p>
<ul>
<li>when asked for the username/password under "Connection Info", that user needs to be a SQL Account that is a sys admin, since the database and logins are going to be created</li>
<li>the database user is listed under 'Database settings', and those can be ignored as the installer will set those and create them automatically</li>
</ul>
<p>The 'sa' account is a built-in SQL account ('system admin'), and the password is usually set in SQL Server itself. Note that you can use this under the 'Connection Info' part of the installer - it's not a security risk, as the installer does not remember this login and after the database is created.</p>
<p>Leave 'Database Settings' section unchanged in most circumstances (make sure the Database name is the actual database you'd like to upgrade).</p>
<p>Without a UserId/password listed in your connection string, Windows Authentication is used (the default). When asked for the username/password under "Connection Info", that user needs to be a SQL Account that is a sys admin, since the database and logins are going to be created. The database user is listed under 'Database settings', and should be left as their defaults as the installer sets and creates those automatically.</p>
<p>The 'sa' account is a built-in SQL account ('system admin'), and the password is usually set in SQL Server itself. Note that you can use this under the 'Connection Info' part of the installer. Please note that the installer does not remember this login after the database is created.</p>
<p>Leave 'Database Settings' section unchanged, as filled by default (make sure the Database name is the actual database you'd like to upgrade).</p>
<h3 id="adding-an-application-server">Adding An Application Server<a class="headerlink" href="#adding-an-application-server" title="Permanent link">&para;</a></h3>
<p>Use this option when you already have another application server and database server configured and operational. Installation is very similar to a <a href="#Installing-the-Software">standard installation</a> normally. However, when the page about the SQL Server and Database is displayed, it requires you to point to the existing SQL Server and Database. </p>
<p><img alt="" src="../img/Installing_SpiraPlan_db-options.png" /></p>
Expand Down
2 changes: 2 additions & 0 deletions Spira-Administration-Guide/System-Users/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4774,6 +4774,8 @@ <h2 id="login-providers">Login Providers<a class="headerlink" href="#login-provi
<p>On the provider details page you can set a provider to active or inactive. Different providers have different required fields. For your provider, make sure to fill in the required fields with the specific information that the provider generates for you. Every provider needs at least a <code>client id</code> and <code>client secret</code>. For users to be able to login using the provider make sure to set the provider to active and hit <code>Save</code>. This will make sure that the right button shows up on the login screen. </p>
<p>Note that you can only deactivate a provider that does not have any users linked to it.</p>
<p><img alt="user administration login provider details page for Google" src="../img/System_Users_oauth-admin-provider.png" /></p>
<p>Once you have setup a login provider, users will see a button for that provider on the Spira login page:</p>
<p><img alt="user administration login provider details page for AzureAD" src="../img/System_Users_oauth-admin-provider-AzureAD.png" /></p>
<h3 id="how-to-set-up-a-provider-to-integrate-with-spira">How to set up a provider to integrate with Spira<a class="headerlink" href="#how-to-set-up-a-provider-to-integrate-with-spira" title="Permanent link">&para;</a></h3>
<p>Below is a general set of instructions about how to set up the provider and Spira to work together. However, the providers may have changed their process or documentation, so please consult the provider about configuring their system.</p>
<ol>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Spira-User-Manual/Requirements-Management/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5313,7 +5313,7 @@ <h3 id="insert">Insert<a class="headerlink" href="#insert" title="Permanent link
<ul>
<li>to insert a requirement <em>above</em> a requirement, select that requirement (click its checkbox) then click Insert</li>
<li>to insert a requirement below an existing item, use the Insert &gt; Child Requirement option. </li>
<li>to insdert a requirement at the end of the list, click Insert with nothing selected. Note that if the full list of requirements are paginated, the new requirement will be at the bottom of the last page.</li>
<li>to insert a requirement at the end of the list, click "Insert" with no requirement selected. Note that if the full list of requirements are paginated, the new requirement will be at the bottom of the last page.</li>
</ul>
<p>Once the new requirement has been inserted, the item is switched to "Edit" mode so that you can rename the default name and choose a priority, status and/or author.</p>
<h3 id="delete">Delete<a class="headerlink" href="#delete" title="Permanent link">&para;</a></h3>
Expand Down
16 changes: 16 additions & 0 deletions Spira-User-Manual/Task-Tracking/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1014,6 +1014,13 @@
Followers
</a>

</li>

<li class="md-nav__item">
<a href="#component" class="md-nav__link">
Component
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -4939,6 +4946,13 @@
Followers
</a>

</li>

<li class="md-nav__item">
<a href="#component" class="md-nav__link">
Component
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -5355,6 +5369,8 @@ <h3 id="followers_1">Followers<a class="headerlink" href="#followers_1" title="P
<p><img alt="" src="../img/Task_Tracking_101.png" /></p>
<p>To view information about the follower, or to unfollow them from the item, hover over their avatar to display a user profile card.</p>
<p><img alt="" src="../img/Task_Tracking_102.png" /></p>
<h3 id="component">Component<a class="headerlink" href="#component" title="Permanent link">&para;</a></h3>
<p>For tasks, the component field works differently than it does normal as with other artifacts. The component field for a task is disabled and is derived from the component of any requirement that the task is associated with. If the task has no requirement associated with it, then the task's component field will be empty.</p>
<h3 id="overview-comments">Overview -- Comments<a class="headerlink" href="#overview-comments" title="Permanent link">&para;</a></h3>
<p>Read about <a href="../Application-Wide/#comments">how the comments works</a></p>
<h3 id="attachments">Attachments<a class="headerlink" href="#attachments" title="Permanent link">&para;</a></h3>
Expand Down
Binary file modified Spira-User-Manual/img/Document_Management_330.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Document_Management_96.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Incident_Tracking_241.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Planning_Board_414.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Program_Management_products-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Release_Management_271.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Release_Management_272.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Release_Management_273.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Reports_Center_337.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Requirements_Management_100.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Requirements_Management_101.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Spira-User-Manual/img/Requirements_Management_102.png
Binary file modified Spira-User-Manual/img/Requirements_Management_114.png
Binary file modified Spira-User-Manual/img/Requirements_Management_117.png
Binary file modified Spira-User-Manual/img/Requirements_Management_119.png
Binary file modified Spira-User-Manual/img/Requirements_Management_96.png
Binary file modified Spira-User-Manual/img/Requirements_Management_97.png
Binary file modified Spira-User-Manual/img/Risks_Management_100.png
Binary file modified Spira-User-Manual/img/Risks_Management_114.png
Binary file modified Spira-User-Manual/img/Risks_Management_97.png
Binary file modified Spira-User-Manual/img/Task_Tracking_100.png
Binary file modified Spira-User-Manual/img/Task_Tracking_289.png
Binary file modified Spira-User-Manual/img/Task_Tracking_290.png
Binary file modified Spira-User-Manual/img/Test_Case_Management_100.png
Binary file modified Spira-User-Manual/img/Test_Case_Management_147.png
Binary file modified Spira-User-Manual/img/Test_Case_Management_156.png
Binary file modified Spira-User-Manual/img/Test_Case_Management_217.png
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit b87d66f

Please sign in to comment.