Bundler creates valid links for migration documents

- Updated the bundler to update links in migration documentation files. - Updated `AddressMigration.md` with working link.
semanticarts · Jul 8, 2024 · 7ca0a82 · 7ca0a82
1 parent 34e8f25
commit 7ca0a82
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 29 deletions.
diff --git a/bundle.yaml b/bundle.yaml
@@ -191,17 +191,13 @@ actions:
   message: "Copying license."
   source: "{input}/LICENSE.txt"
   target: "{output}"
-- action: "copy"
-  message: "Copying migration queries and scripts."
-  source: "{input}/migration"
-  target: "{output}/migration"
 - action: "copy"
   message: "Copying documentation and patching local links."
   source: "{input}/docs"
   target: "{output}/Documentation"
   replace:
-    from: "models\/"
-    to: "Models\/"
+    from: "\\./models"
+    to: "\\./Models"
   includes:
     - "ReleaseNotes.md"
     - "MajorVersionMigration.md"
@@ -230,41 +226,93 @@ actions:
   includes:
     - "*.md"
 - action: "move"
-  message: "Patching links in the documentation directory."
+  message: "Patching local links in the documentation directory."
   source: "{output}/Documentation/"
   target: "{output}/Documentation/"
   includes:
     - "*.html"
   replace:
-    from: "\\(./(.*)\\.md\\)"
-    to: "(./\\g<1>.html)"
+    from: "\\./(.*)\\.md"
+    to: "./\\g<1>.html"
 - action: "move"
-  message: "Patching links in the documentation models directory."
+  message: "Patching local links in the documentation models directory."
   source: "{output}/Documentation/Models/"
   target: "{output}/Documentation/Models/"
   includes:
     - "*.html"
   replace:
     from: "\\(./(.*)\\.md\\)"
     to: "(./\\g<1>.html)"
+- action: "copy"
+  message: "Copying migration queries and scripts."
+  source: "{input}/migration"
+  target: "{output}/migration"
 - action: "markdown"
-  message: "Formatting gist 11.0 migration readme."
-  source: "{output}/migration/v11.0/README.md"
-  target: "{output}/migration/v11.0/README.html"
+  message: "Formatting gist 11.0 migration documentation as HTML."
+  source: "{output}/migration/v11.0/"
+  target: "{output}/migration/v11.0/"
+  includes:
+    - "*.md"
 - action: "markdown"
-  message: "Formatting time-related changes documentation."
-  source: "{output}/migration/v11.0/TimeRelatedChanges_v11.md"
-  target: "{output}/migration/v11.0/TimeRelatedChanges_v11.html"
+  message: "Formatting gist 13.0 migration documentation as HTML."
+  source: "{output}/migration/v11.0/"
+  target: "{output}/migration/v11.0/"
+  includes:
+    - "*.md"
+- action: "move"
+  message: "Patching local links in the migration directory."
+  source: "{output}/Migration/v11.0/"
+  target: "{output}/Migration/v11.0/"
+  includes:
+    - "*.html"
+  # Replaces ./*.md local links with ./*.html
+  replace:
+    from: "./(.*)\\.md"
+    to: "./\\g<1>.html"
 - action: "markdown"
-  message: "Formatting gist 12.0 migration readme."
-  source: "{output}/migration/v12.0/README.md"
-  target: "{output}/migration/v12.0/README.html"
-# Uncomment once this file has been created
-# - action: "markdown"
-#   message: "Formatting gist 13.0 migration readme."
-#   source: "{output}/migration/v13.0/README.md"
-#   target: "{output}/migration/v13.0/README.html"
+  message: "Formatting gist 12.0 migration documentation as HTML."
+  source: "{output}/migration/v12.0/"
+  target: "{output}/migration/v12.0/"
+  includes:
+    - "*.md"
+- action: "markdown"
+  message: "Formatting gist 13.0 migration documentation as HTML."
+  source: "{output}/migration/v12.0/"
+  target: "{output}/migration/v12.0/"
+  includes:
+    - "*.md"
+- action: "move"
+  message: "Patching local links in the migration directory."
+  source: "{output}/Migration/v12.0/"
+  target: "{output}/Migration/v12.0/"
+  includes:
+    - "*.html"
+  # Replaces ./*.md local links with ./*.html
+  replace:
+    from: "./(.*)\\.md"
+    to: "./\\g<1>.html"
+- action: "move"
+  message: "Patching local links in the v13.0 migration directory."
+  source: "{output}/migration/v13.0/"
+  target: "{output}/migration/v13.0/"
+  includes:
+    - "*.md"
+  replace:
+    from: "docs/models"
+    to: "Documentation/Models"
 - action: "markdown"
-  message: "Formatting address migration documentation."
-  source: "{output}/migration/v13.0/AddressMigration.md"
-  target: "{output}/migration/v13.0/AddressMigration.html"
+  message: "Formatting gist 13.0 migration documentation as HTML."
+  source: "{output}/migration/v13.0/"
+  target: "{output}/migration/v13.0/"
+  includes:
+    - "*.md"
+- action: "move"
+  message: "Patching local links in the migration directory."
+  source: "{output}/Migration/v13.0/"
+  target: "{output}/Migration/v13.0/"
+  includes:
+    - "*.html"
+  # Replaces ./*.md local links with ./*.html
+  replace:
+    from: "./(.*)\\.md"
+    to: "./\\g<1>.html"
diff --git a/migration/v13.0/AddressMigration.md b/migration/v13.0/AddressMigration.md
@@ -2,7 +2,7 @@
 
 ## Overview
 
-gist 13.0.0 introduces a new model of physical and electronic addresses (see [full documentation of the model](./docs/models/AddressGuidance.md)). Because the new model shifts a large part of the semantics from classes to user-defined categories, the migration can be only partially automated. This guide documents the steps required to migrate your data and ontology extensions into the new model without loss of meaning.
+gist 13.0.0 introduces a new model of physical and electronic addresses (see [full documentation of the model](../../docs/models/AddressGuidance.md)). Because the new model shifts a large part of the semantics from classes to user-defined categories, the migration can be only partially automated. This guide documents the steps required to migrate your data and ontology extensions into the new model without loss of meaning.
 
 ## Automated Steps
 
@@ -51,4 +51,4 @@ Sample extension ontology changes:
 
 gist 12 and earlier defined a general relationship `gist:hasAddress` between address-holder and address, with one more specific subproperty `gist:hasCommunicationAddress` to distinguish an address used, say, for personal communications from one used for, e.g., receiving packages. gist 13 transfers this distinction to a new category class `gist:AddressUsageType`. You might define `my:_AddressUsageType_personal` and `my:_AddressUsageType_receiving` to make this distinction.
 
-The new model provides flexibility to express more nuanced types of address usage and communication preferences than has previously been available. Consult the [full documentation of the model](/docs/models/AddressGuidance.md) to learn how to take advantage of these options.
+The new model provides flexibility to express more nuanced types of address usage and communication preferences than has previously been available. Consult the [full documentation of the model](../../docs/models/AddressGuidance.md) to learn how to take advantage of these options.