Conversation
Rewrite
simonhbor
left a comment
There was a problem hiding this comment.
A few stylistic changes. It is hard to tell what the final version is and how clear it is, but please address these issues for now. I suggest getting Bruno to review before merging too.
| - Active Status: The account must be active and have login access to Spira. | ||
| - Dedicated Exclusivity: Do not use the personal credentials of a human team member. A dedicated service account ensures that changes made by the integration are clearly marked in the audit logs (e.g., "Updated by DataSync"), preventing confusion and making troubleshooting much easier. | ||
| - Product Membership: The user must be explicitly added as a member of every Spira product you intend to synchronize. | ||
| - Proper Project Roles: The user must be assigned a Project Role with sufficient permissions to view, create, and modify all artifacts involved in the sync. For example, if you are syncing bugs, the user needs "Create" and "Modify" permissions for Incidents. If they lack these permissions, the sync will fail when trying to write data. |
There was a problem hiding this comment.
Should be "Product Roles" throughout this bullet
| - [x] [Download the plugin](#download-plugins-for-the-service) for the application you will sync with | ||
| - [x] [Configure the service](#configure-the-service) | ||
| - [x] [Start the Datasync service](#start-the-datasync-service) | ||
| - [x] [Download the plugin](https://www.inflectra.com/Downloads/SpiraDataSync_StandaloneService_v8.9.0.0_x64.zip) for the application you will sync with |
There was a problem hiding this comment.
I think we should not put the specific version to download here as each time it is updated we will need to update it here and we will get it wrong
| - [x] [Configure the service](#configure-the-service) | ||
| - [x] [Start the Datasync service](#start-the-datasync-service) | ||
| - [x] [Download the plugin](https://www.inflectra.com/Downloads/SpiraDataSync_StandaloneService_v8.9.0.0_x64.zip) for the application you will sync with | ||
| - [x] [Configure the service](https://spiradoc.inflectra.com/External-Bug-Tracking-Integration/Setting-up-Data-Synchronization/#configure-the-service) |
There was a problem hiding this comment.
You should never use direct links like this in the documentation. Kiro can do auto complete for you. Please look at other examples of links throughout the docs to see how we do it. Any questions let me know
| XML: | ||
|
|
||
| ```xml | ||
| ```python |
There was a problem hiding this comment.
why have you python here? It should xml
| </configuration> | ||
|
|
||
| ``` | ||
| 3. Update the following <value> tags to match your environment: |
There was a problem hiding this comment.
This should not be 3. The last numbered item was 3. You may therefore think to put 4 here but that is wrong - MD will make this 1.
So if you want this to be 4. instead you should make the numbered list just a bulleted list
|
|
||
| ### Option C: Setup the Desktop DataSync | ||
|
|
||
|  |
There was a problem hiding this comment.
Looks like this image is 100% removed. If so please delete it from the img files too
Rewrite