Document usage of the include-jira-css-styles flag

solidify · Sep 7, 2023 · 13f3f01 · 13f3f01
1 parent 1dfdec2
commit 13f3f01
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 0 deletions.
diff --git a/docs/Samples/config-agile.json b/docs/Samples/config-agile.json
@@ -15,6 +15,8 @@
   "base-iteration-path": "Migrated",
   "ignore-failed-links": true,
   "include-link-comments": true,
+  "include-jira-css-styles": true,
+  "sleep-time-between-revision-import-milliseconds": 0,
   "process-template": "Agile",
   "link-map": {
     "link": [

diff --git a/docs/Samples/config-basic.json b/docs/Samples/config-basic.json
@@ -15,6 +15,7 @@
   "base-iteration-path": "Migrated",
   "ignore-failed-links": true,
   "include-link-comments": true,
+  "include-jira-css-styles": true,
   "sleep-time-between-revision-import-milliseconds": 0,
   "process-template": "Basic",
   "link-map": {

diff --git a/docs/Samples/config-cmmi.json b/docs/Samples/config-cmmi.json
@@ -15,6 +15,7 @@
     "base-iteration-path": "SourceProject_Migrated",
     "ignore-failed-links": true,
     "include-link-comments": true,
+    "include-jira-css-styles": true,
     "sleep-time-between-revision-import-milliseconds": 0,
     "process-template": "CMMI",
     "link-map": {

diff --git a/docs/Samples/config-scrum.json b/docs/Samples/config-scrum.json
@@ -15,6 +15,7 @@
   "base-iteration-path": "Migrated",
   "ignore-failed-links": true,
   "include-link-comments": true,
+  "include-jira-css-styles": true,
   "sleep-time-between-revision-import-milliseconds": 0,
   "process-template": "Scrum",
   "link-map": {

diff --git a/docs/config.md b/docs/config.md
@@ -33,6 +33,7 @@ The migration configuration file is defined in a json file with the properties d
 |**base-iteration-path**|False|string|Iteration path. Default is empty.|
 |**ignore-failed-links**|False|boolean|Set to True if failed links are to be ignored. Default = False.|
 |**include-link-comments**|False|boolean|Set to True to get a verbose comment on the work item for every work item link created. Default = True.|
+|**include-jira-css-styles**|True|boolean|Set to True to generate and include confluence CSS Stylesheets for description, repro steps and comments. Default = True.|
 |**sleep-time-between-revision-import-milliseconds**|False|integer|How many milliseconds to sleep between each revision import. Use this if throttling is an issue for ADO Services. Default = 0 (no sleep).|
 |**process-template**|False|string|Process template in the target DevOps project. Supported values: Scrum, Agile or CMMI. Default = "Scrum".|
 |**link-map**|True|json|List of **links** to map between Jira and Azure DevOps/TFS work item link types.|