docs(theme): sync docs with themes #509

venetrius · 2024-11-05T12:44:20Z

related to: https://github.com/camunda/team-automation-platform/issues/160

related to: camunda/team-automation-platform/issues/160

venetrius · 2024-11-05T15:59:02Z

enterprise/themes/camunda/layouts/_default/sitemap.xml

@@ -0,0 +1,28 @@
+{{/* This template is overridden to emit permalinks that (1) are absolute, and (2) specify the most recent version. This allows us to submit the sitemap to crawlers with true canonical URLs. */}}


Added / updated 2 years ago in themes:
camunda/camunda-docs-theme@1f9e19d
Present in camunda-docs-theme:
https://github.com/camunda/camunda-docs-manual/blob/master/themes/camunda/layouts/_default/sitemap.xml

venetrius · 2024-11-06T12:05:37Z

enterprise/themes/camunda/layouts/partials/footer.html

@@ -8,7 +8,7 @@
          </p>

          <p>
-            <a href="http://camunda.org">camunda.org</a> and <a href="{{ .Site.BaseURL }}">docs.camunda.org</a> are part of Camunda Platform
+            <a href="http://camunda.org">camunda.org</a> and <a href="{{ .Site.BaseURL }}">docs.camunda.org</a> are both part of Camunda


File was out of sync, changes in themes repo are newer

Changes from docs-static are three years old:
d55f2f2

Changed in themes 2024.03.05:

camunda/camunda-docs-theme@c0b25b7

venetrius · 2024-11-06T12:05:57Z

enterprise/themes/camunda/layouts/partials/header.html

@@ -5,7 +5,7 @@
  <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
  new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
  j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-  'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+  'https://ssgtm.camunda.org/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);


Intended changes

venetrius · 2024-11-06T12:10:11Z

enterprise/themes/camunda/layouts/partials/header.html

@@ -51,7 +51,7 @@

 <nav class="navbar navbar-fixed-top">
  <div class="navbar-container navbar-top-section">
-    <span>Looking for Camunda Platform 8? >></span>
+    <span>Looking for Camunda 8? >></span>


(also line 20 & 22)
File was out of sync, changes in themes repo are newer

Changes from docs-static are from Mar 4, 2022:
c7e4d7f

Changed in themes are from Mar 5, 2022:

camunda/camunda-docs-theme@c0b25b7

venetrius · 2024-11-06T12:13:01Z

enterprise/themes/camunda/layouts/shortcodes/ee-download.html

              </p>
            </div>

            <div class="full">
              <h4>Full Distribution</h4>

              <a class="details full" href="/manual/latest/installation/full">What is the Full Distribution?</a>
-              <a class="details run" href="/manual/latest/installation/camunda-bpm-run">How to install Camunda Platform Run?</a>
+              <a class="details run" href="/manual/latest/installation/camunda-bpm-run">How to install Camunda 7 Run?</a>


Out of sync
Changes in doc-static many years old:
https://github.com/camunda/camunda-docs-static/blame/master/enterprise/themes/camunda/layouts/shortcodes/ee-download.html#L52

Changes in themes are from this year:
https://github.com/camunda/camunda-docs-theme/blame/master/layouts/shortcodes/ee-download.html#L60

venetrius · 2024-11-06T12:14:28Z

enterprise/themes/camunda/layouts/shortcodes/enterprise.html

@@ -6,6 +6,6 @@ <h3>Enterprise Feature</h3>
  <p>
    Check the <a href="http://camunda.com/platform-7/editions/">Camunda enterprise homepage</a>
    for more information or get your
-    <a href="http://camunda.com/download/enterprise/">free trial version.</a>
+    <a href="https://camunda.com/download/enterprise/">free trial version.</a>


Updated, see: camunda/camunda-docs-manual#1694 (comment)

venetrius · 2024-11-06T12:14:55Z

get-started/themes/camunda/layouts/_default/sitemap.xml

@@ -0,0 +1,28 @@
+{{/* This template is overridden to emit permalinks that (1) are absolute, and (2) specify the most recent version. This allows us to submit the sitemap to crawlers with true canonical URLs. */}}


Same as https://github.com/camunda/camunda-docs-static/pull/509/files#r1829611790

venetrius · 2024-11-06T12:15:39Z

get-started/themes/camunda/layouts/partials/footer.html

@@ -8,7 +8,7 @@
          </p>

          <p>
-            <a href="http://camunda.org">camunda.org</a> and <a href="{{ .Site.BaseURL }}">docs.camunda.org</a> are part of Camunda Platform
+            <a href="http://camunda.org">camunda.org</a> and <a href="{{ .Site.BaseURL }}">docs.camunda.org</a> are both part of Camunda


Same as https://github.com/camunda/camunda-docs-static/pull/509/files#r1830906190

venetrius · 2024-11-06T12:16:24Z

security/themes/camunda/layouts/partials/footer.html

@@ -8,7 +8,7 @@
          </p>

          <p>
-            <a href="http://camunda.org">camunda.org</a> and <a href="{{ .Site.BaseURL }}">docs.camunda.org</a> are part of Camunda Platform
+            <a href="http://camunda.org">camunda.org</a> and <a href="{{ .Site.BaseURL }}">docs.camunda.org</a> are both part of Camunda


Same as https://github.com/camunda/camunda-docs-static/pull/509/files#r1830906190

venetrius · 2024-11-06T12:16:58Z

security/themes/camunda/layouts/_default/sitemap.xml

@@ -0,0 +1,28 @@
+{{/* This template is overridden to emit permalinks that (1) are absolute, and (2) specify the most recent version. This allows us to submit the sitemap to crawlers with true canonical URLs. */}}


Same as https://github.com/camunda/camunda-docs-static/pull/509/files#r1829611790

venetrius · 2024-11-06T12:17:38Z

security/themes/camunda/layouts/shortcodes/enterprise.html

@@ -4,8 +4,8 @@ <h3>Enterprise Feature</h3>
  <p class="description">{{ trim .Inner "" | markdownify }}</p>

  <p>
-    Check the <a href="http://camunda.com/bpm/enterprise/">Camunda enterprise homepage</a>
+    Check the <a href="http://camunda.com/platform-7/editions/">Camunda enterprise homepage</a>


Was out of sync with themes

venetrius · 2024-11-06T12:19:17Z

security/themes/camunda/layouts/shortcodes/ee-download.html

@@ -18,7 +18,7 @@

  camDownloads.servers = {};
  {{ range $info := sort $.Page.Params.downloads.servers "weight" }}
-  camDownloads.servers['{{ $info.path }}'] = '{{ $info.name }}';{{ end }}
+  camDownloads.servers['{{ $info.id }}'] = {name:'{{ $info.name }}',path:'{{ $info.path }}'};{{ end }}


Changes were not synced from themes.
Commit: camunda/camunda-docs-theme@48e728b

venetrius · 2024-11-06T12:20:57Z

get-started/themes/camunda/layouts/partials/header.html

@@ -5,7 +5,7 @@
  <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
  new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
  j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-  'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+  'https://ssgtm.camunda.org/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);


Intended change

venetrius · 2024-11-06T12:28:34Z

get-started/themes/camunda/layouts/partials/header.html

@@ -34,6 +34,13 @@
  {{ $styles := resources.Get "css/docs.css" | fingerprint }}

  <link rel="stylesheet" href="{{ $styles.Permalink }}" integrity="{{ $styles.Data.Integrity }}">
+  {{- $permalink := .Permalink }}


Last changed in themes in Nov 30, 2022:
camunda/camunda-docs-theme@1f9e19d#diff-ef4bb046d34a9de9dcbb20a75fc9ced0448446808348683926f22bd7192c654aL6

Section removed from docs-static: Aug 8, 2023
0b71c15#diff-e76d120cd614de8045567875ede423e24392c156e53da5b954615898f4b2d54bL38

TODO: update themes to remove code that was removed in 0b71c15#diff-e76d120cd614de8045567875ede423e24392c156e53da5b954615898f4b2d54bL38

Updated in themes.

venetrius · 2024-11-06T13:09:32Z

get-started/themes/camunda/layouts/shortcodes/enterprise.html

@@ -4,8 +4,8 @@ <h3>Enterprise Feature</h3>
  <p class="description">{{ trim .Inner "" | markdownify }}</p>

  <p>
-    Check the <a href="http://camunda.com/bpm/enterprise/">Camunda enterprise homepage</a>
+    Check the <a href="http://camunda.com/platform-7/editions/">Camunda enterprise homepage</a>


Was out of sync with themes

venetrius · 2024-11-06T13:11:09Z

get-started/themes/camunda/layouts/shortcodes/ee-download.html

@@ -18,7 +18,7 @@

  camDownloads.servers = {};
  {{ range $info := sort $.Page.Params.downloads.servers "weight" }}
-  camDownloads.servers['{{ $info.path }}'] = '{{ $info.name }}';{{ end }}
+  camDownloads.servers['{{ $info.id }}'] = {name:'{{ $info.name }}',path:'{{ $info.path }}'};{{ end }}


Out of sync
Changes in doc-static many-many years old:
https://github.com/camunda/camunda-docs-static/blame/master/get-started/themes/camunda/layouts/shortcodes/ee-download.html#L21

Changes in themes are from this year:
https://github.com/camunda/camunda-docs-theme/blame/master/layouts/shortcodes/ee-download.html#L60

venetrius · 2024-11-06T13:26:57Z

enterprise/themes/camunda/layouts/partials/header.html

@@ -34,13 +34,6 @@
  {{ $styles := resources.Get "css/docs.css" | fingerprint }}

  <link rel="stylesheet" href="{{ $styles.Permalink }}" integrity="{{ $styles.Data.Integrity }}">


See #509 (comment)

venetrius · 2024-11-06T13:27:34Z

get-started/themes/camunda/layouts/partials/header.html

@@ -17,9 +17,9 @@

  <meta name="viewport" content="width=device-width" />

-  <meta name="description" content="documentation of the Camunda Platform 7" />
+  <meta name="description" content="documentation of Camunda 7" />


Was out of sync with themes

venetrius · 2024-11-06T13:27:45Z

security/themes/camunda/layouts/partials/header.html

@@ -5,7 +5,7 @@
  <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
  new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
  j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-  'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+  'https://ssgtm.camunda.org/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);


Intended changes

venetrius · 2024-11-06T13:27:55Z

security/themes/camunda/layouts/partials/header.html

@@ -17,9 +17,9 @@

  <meta name="viewport" content="width=device-width" />

-  <meta name="description" content="documentation of the Camunda Platform 7" />
+  <meta name="description" content="documentation of Camunda 7" />


was out of sync with themes

tasso94

Good job! 👍

venetrius self-assigned this Nov 5, 2024

venetrius added 3 commits November 5, 2024 16:50

docs(theme): sync security docs

a9ef1e7

related to: camunda/team-automation-platform/issues/160

docs(theme): sync enterprise docs

175e206

related to: camunda/team-automation-platform/issues/160

docs(theme): sync get-starte docs

7ac5a40

related to: camunda/team-automation-platform/issues/160

venetrius force-pushed the 160-update-google-tag-manager-link branch from 9a2141c to 7ac5a40 Compare November 5, 2024 15:55

venetrius commented Nov 5, 2024

View reviewed changes

venetrius commented Nov 6, 2024

View reviewed changes

sync changes regarding docs-static 0b71c15

febe380

venetrius mentioned this pull request Nov 6, 2024

docs(header): update link for googleTagManager camunda/camunda-docs-theme#50

Merged

venetrius commented Nov 6, 2024

View reviewed changes

venetrius requested a review from tasso94 November 6, 2024 14:46

tasso94 approved these changes Nov 8, 2024

View reviewed changes

venetrius merged commit ce72d0e into master Nov 8, 2024
1 check passed

venetrius deleted the 160-update-google-tag-manager-link branch November 8, 2024 10:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(theme): sync docs with themes #509

docs(theme): sync docs with themes #509

venetrius commented Nov 5, 2024

venetrius Nov 5, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

venetrius Nov 6, 2024

tasso94 left a comment

		@@ -0,0 +1,28 @@
		{{/* This template is overridden to emit permalinks that (1) are absolute, and (2) specify the most recent version. This allows us to submit the sitemap to crawlers with true canonical URLs. */}}

		@@ -34,13 +34,6 @@
		{{ $styles := resources.Get "css/docs.css" \| fingerprint }}

		<link rel="stylesheet" href="{{ $styles.Permalink }}" integrity="{{ $styles.Data.Integrity }}">

docs(theme): sync docs with themes #509

docs(theme): sync docs with themes #509

Conversation

venetrius commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tasso94 left a comment

Choose a reason for hiding this comment