Add in details about how to use mike for versioning docs

Author: pflooky

CHANGELOG.md

@@ -9,6 +9,7 @@ This document tracks the history and evolution of the **Open Data Contract Stand
 * Change `slaProperties.valueExt` data type from `string` to `oneOf[string, number]`
 * Update [examples](docs/examples) to adhere to JSON schema
 * Full example from README directs to [full-example.yaml](docs/examples/all/full-example.yaml)
+* Add in mkdocs for creating documentation website
 
 # v2.2.1 - 2023-12-18 - APPROVED
 

README.md

@@ -60,4 +60,27 @@ Formerly known as the data contract template, this standard is used to implement
 ### How does PayPal use Data Contracts?
 PayPal uses data contracts in many ways, but this [article](https://medium.com/paypal-tech/the-next-generation-of-data-platforms-is-the-data-mesh-b7df4b825522) from the [PayPal Technology blog](https://medium.com/paypal-tech) gives a good introduction.
 
-
+### Mkdocs mike versioning
+To start with using [mike](https://github.com/jimporter/mike) as a tool for versioning the documentation, the following was run:
+
+```bash
+pip install mike
+cd open-data-contract-standard                    #ensure you are inside the repo
+mike deploy --push --update-aliases v2.2.1 latest #set latest version to v2.2.1
+mike set-default --push latest                    #by default, users will go to latest
+```
+
+#### Deploying a new version
+Given that the Github action [here](.github/workflows/docs-site-deploy.yaml) it set to trigger when a new tag version is
+created, all that is required is to:
+1. [Create a new release](https://github.com/bitol-io/open-data-contract-standard/releases)
+2. Put in new tag version for release (follows pattern v*)
+3. Once release is created with new tag version, the Github action gets kicked off and mike will deploy the latest documentation linked to latest version tag
+
+#### Delete version
+If a version tag was pushed that was incorrect, it can be deleted via:
+
+```bash
+mike deploy --push --update-aliases <previous tag version> latest #set latest version to previous tag version
+mike delete <incorrect tag> --push
+```

site/404.html

@@ -14,7 +14,7 @@
 
 
 
-      <link rel="icon" href="/open-data-contract-standard/img/Bitol_Logo_icon_color.svg">
+      <link rel="icon" href="/open-data-contract-standard/v2.2.1/img/Bitol_Logo_icon_color.svg">
       <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.2+insiders-4.42.0">
 
 
@@ -23,10 +23,10 @@
 
 
 
-      <link rel="stylesheet" href="/open-data-contract-standard/assets/stylesheets/main.63a9ca82.min.css">
+      <link rel="stylesheet" href="/open-data-contract-standard/v2.2.1/assets/stylesheets/main.63a9ca82.min.css">
 
 
-        <link rel="stylesheet" href="/open-data-contract-standard/assets/stylesheets/palette.46987102.min.css">
+        <link rel="stylesheet" href="/open-data-contract-standard/v2.2.1/assets/stylesheets/palette.46987102.min.css">
 
 
 
@@ -45,7 +45,7 @@
 
 
 
-    <script>__md_scope=new URL("/open-data-contract-standard/",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("/open-data-contract-standard/v2.2.1",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
 
 
@@ -81,9 +81,9 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="/open-data-contract-standard/." title="Open Data Contract Standard" class="md-header__button md-logo" aria-label="Open Data Contract Standard" data-md-component="logo">
+    <a href="/open-data-contract-standard/v2.2.1/." title="Open Data Contract Standard" class="md-header__button md-logo" aria-label="Open Data Contract Standard" data-md-component="logo">
 
-  <img src="/open-data-contract-standard/img/Bitol_Logo_icon_color.svg" alt="logo">
+  <img src="/open-data-contract-standard/v2.2.1/img/Bitol_Logo_icon_color.svg" alt="logo">
 
     </a>
     <label class="md-header__button md-icon" for="__drawer">
@@ -181,7 +181,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/open-data-contract-standard/." class="md-tabs__link">
+      <a href="/open-data-contract-standard/v2.2.1/." class="md-tabs__link">
 
 
 
@@ -198,7 +198,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/open-data-contract-standard/standard/" class="md-tabs__link">
+      <a href="/open-data-contract-standard/v2.2.1/standard/" class="md-tabs__link">
 
 
 
@@ -215,7 +215,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/open-data-contract-standard/examples/" class="md-tabs__link">
+      <a href="/open-data-contract-standard/v2.2.1/examples/" class="md-tabs__link">
 
 
 
@@ -232,7 +232,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/open-data-contract-standard/contributing/" class="md-tabs__link">
+      <a href="/open-data-contract-standard/v2.2.1/contributing/" class="md-tabs__link">
 
 
 
@@ -268,9 +268,9 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="/open-data-contract-standard/." title="Open Data Contract Standard" class="md-nav__button md-logo" aria-label="Open Data Contract Standard" data-md-component="logo">
+    <a href="/open-data-contract-standard/v2.2.1/." title="Open Data Contract Standard" class="md-nav__button md-logo" aria-label="Open Data Contract Standard" data-md-component="logo">
 
-  <img src="/open-data-contract-standard/img/Bitol_Logo_icon_color.svg" alt="logo">
+  <img src="/open-data-contract-standard/v2.2.1/img/Bitol_Logo_icon_color.svg" alt="logo">
 
     </a>
     Open Data Contract Standard
@@ -296,7 +296,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/open-data-contract-standard/." class="md-nav__link">
+      <a href="/open-data-contract-standard/v2.2.1/." class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -321,7 +321,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/open-data-contract-standard/standard/" class="md-nav__link">
+      <a href="/open-data-contract-standard/v2.2.1/standard/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -346,7 +346,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/open-data-contract-standard/examples/" class="md-nav__link">
+      <a href="/open-data-contract-standard/v2.2.1/examples/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -371,7 +371,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/open-data-contract-standard/contributing/" class="md-nav__link">
+      <a href="/open-data-contract-standard/v2.2.1/contributing/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -493,12 +493,12 @@ <h1>404 - Not found</h1>
     </div>
 
 
-    <script id="__config" type="application/json">{"base": "/open-data-contract-standard/", "features": ["navigation.tabs", "navigation.sections", "navigation.instant", "navigation.instant.prefetch", "navigation.tracking", "navigation.top", "navigation.footer", "navigation.path", "content.code.copy", "content.code.select", "content.tabs.link", "toc.integrate", "toc.follow"], "search": "/open-data-contract-standard/assets/javascripts/workers/search.f2da59ea.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
+    <script id="__config" type="application/json">{"base": "/open-data-contract-standard/v2.2.1", "features": ["navigation.tabs", "navigation.sections", "navigation.instant", "navigation.instant.prefetch", "navigation.tracking", "navigation.top", "navigation.footer", "navigation.path", "content.code.copy", "content.code.select", "content.tabs.link", "toc.integrate", "toc.follow"], "search": "/open-data-contract-standard/v2.2.1/assets/javascripts/workers/search.f2da59ea.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
 
 
-      <script src="/open-data-contract-standard/assets/javascripts/bundle.ef51cdc3.min.js"></script>
+      <script src="/open-data-contract-standard/v2.2.1/assets/javascripts/bundle.ef51cdc3.min.js"></script>
 
-        <script src="/open-data-contract-standard/js/open_in_new_tab.js"></script>
+        <script src="/open-data-contract-standard/v2.2.1/js/open_in_new_tab.js"></script>
 
 
   </body>

site/contributing/index.html

@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/contributing/">
+        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/v2.2.1/contributing/">
 
 
         <link rel="prev" href="../examples/">

site/examples/index.html

@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/examples/">
+        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/v2.2.1/examples/">
 
 
         <link rel="prev" href="../standard/">

site/index.html

@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/">
+        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/v2.2.1/">
 
 
 

site/sitemap.xml

@@ -1,22 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
-         <loc>https://pflooky.github.io/open-data-contract-standard/</loc>
+         <loc>https://pflooky.github.io/open-data-contract-standard/v2.2.1/</loc>
          <lastmod>2024-02-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
-         <loc>https://pflooky.github.io/open-data-contract-standard/contributing/</loc>
+         <loc>https://pflooky.github.io/open-data-contract-standard/v2.2.1/contributing/</loc>
          <lastmod>2024-02-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
-         <loc>https://pflooky.github.io/open-data-contract-standard/standard/</loc>
+         <loc>https://pflooky.github.io/open-data-contract-standard/v2.2.1/standard/</loc>
          <lastmod>2024-02-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
-         <loc>https://pflooky.github.io/open-data-contract-standard/examples/</loc>
+         <loc>https://pflooky.github.io/open-data-contract-standard/v2.2.1/examples/</loc>
          <lastmod>2024-02-27</lastmod>
          <changefreq>daily</changefreq>
     </url>

site/sitemap.xml.gz

@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/standard/">
+        <link rel="canonical" href="https://pflooky.github.io/open-data-contract-standard/v2.2.1/standard/">
 
 
         <link rel="prev" href="..">