LP#1848524: various tweaks

* Renamed the supplimental_ui folder for ease of understanding
* UI Tweaks
* Fixed README.adoc for working repo
* add Next/Previous links at the bottom of the pages

Signed-off-by: blake <blake@mobiusconsortium.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

diff --git a/docs-antora/README.adoc b/docs-antora/README.adoc
index 27ab8ac..f5e6f03 100644 (file)
--- a/docs-antora/README.adoc
+++ b/docs-antora/README.adoc
@@ -4,7 +4,7 @@
 
 [source,bash]
 ----
-$ git clone git://git.evergreen-ils.org/Evergreen.git
+$ git clone git://git.evergreen-ils.org/working/Evergreen.git
 $ cd Evergreen
 $ git checkout collab/blake/LP1848524_antora_ize_docs
 ----

diff --git a/docs-antora/site.yml b/docs-antora/site.yml
index 025b6f3..34b1a28 100644 (file)
--- a/docs-antora/site.yml
+++ b/docs-antora/site.yml
@@ -11,7 +11,7 @@ content:
 ui:
   bundle:
     url: ./ui/build/ui-bundle.zip
-  supplemental_files: ./ui/supplemental_ui
+  supplemental_files: ./ui/ui-lunr
 
 output:
   dir: /var/www/html/prod

diff --git a/docs-antora/ui/src/css/footer.css b/docs-antora/ui/src/css/footer.css
index 6521947..de01cda 100644 (file)
--- a/docs-antora/ui/src/css/footer.css
+++ b/docs-antora/ui/src/css/footer.css
@@ -13,3 +13,18 @@ footer.footer {
 .footer a {
   color: var(--footer-link-font-color);
 }
+
+.article-footer {
+  width: 100%;
+}
+
+.article-footer .article-footer-next {
+  float: right;
+  width: 35%;
+  text-align: right;
+}
+
+.article-footer .article-footer-previous {
+  float: left;
+  width: 35%;
+}

diff --git a/docs-antora/ui/src/css/header.css b/docs-antora/ui/src/css/header.css
index 8ad3528..c919f83 100644 (file)
--- a/docs-antora/ui/src/css/header.css
+++ b/docs-antora/ui/src/css/header.css
@@ -228,7 +228,7 @@ body {
 
   .navbar-end {
     justify-content: flex-end;
-    margin: auto;
+    margin-left: auto;
   }
 
   .navbar-dropdown {

diff --git a/docs-antora/ui/src/css/vars.css b/docs-antora/ui/src/css/vars.css
index 28a9d5c..9e92403 100644 (file)
--- a/docs-antora/ui/src/css/vars.css
+++ b/docs-antora/ui/src/css/vars.css
@@ -18,7 +18,7 @@
   --color-black: #000;
   --color-evergreen: #446129;
   /* fonts */
-  --rem-base: 14; /* used to compute rem value from desired pixel value (e.g., calc(18 / var(--rem-base) * 1rem) = 18px) */
+  --rem-base: 16; /* used to compute rem value from desired pixel value (e.g., calc(18 / var(--rem-base) * 1rem) = 18px) */
   --body-font-size: 1.0625em; /* 17px */
   --body-font-size--desktop: 1.125em; /* 18px */
   --body-font-size--print: 0.9375em; /* 15px */

diff --git a/docs-antora/ui/src/partials/article.hbs b/docs-antora/ui/src/partials/article.hbs
index 11a5117..293f7ac 100644 (file)
--- a/docs-antora/ui/src/partials/article.hbs
+++ b/docs-antora/ui/src/partials/article.hbs
@@ -13,5 +13,13 @@ If you typed the URL of this page manually, please double check that you entered
 <h1 class="page">{{{page.title}}}</h1>
 {{/if}}
 {{{page.contents}}}
+<div class="article-footer">
+    <div class="article-footer-previous">
+        <a href="{{site.path}}{{page.previous.url}}">Previous</a>
+    </div>
+    <div class="article-footer-next">
+        <a href="{{site.path}}{{page.next.url}}">Next</a>
+    </div>
+</div>
 {{/if}}
 </article>

diff --git a/docs-antora/ui/src/partials/header-content.hbs b/docs-antora/ui/src/partials/header-content.hbs
index cd08086..32e99b8 100644 (file)
--- a/docs-antora/ui/src/partials/header-content.hbs
+++ b/docs-antora/ui/src/partials/header-content.hbs
@@ -1,4 +1,4 @@
-<header class="header">
+<header class="header" role="banner">
   <nav class="navbar">
     <div class="navbar-brand">
       <a class="navbar-item" href="{{or site.url (or siteRootUrl siteRootPath)}}">{{site.title}}</a>
@@ -39,5 +39,10 @@
         </div>
       </div>
     </div>
+    {{#if env.DOCSEARCH_ENABLED}}
+        <div class="navbar-item">
+          <input id="search-input" type="text" placeholder="Search docs">
+        </div>
+      {{/if}}
   </nav>
 </header>

diff --git a/docs-antora/ui/src/partials/toolbar.hbs b/docs-antora/ui/src/partials/toolbar.hbs
index 251a51a..3bdb979 100644 (file)
--- a/docs-antora/ui/src/partials/toolbar.hbs
+++ b/docs-antora/ui/src/partials/toolbar.hbs
@@ -6,6 +6,9 @@
 {{> breadcrumbs}}
 {{> page-versions}}
   {{#if (and page.editUrl (not page.origin.private))}}
-  <div class="edit-this-page"><a href="{{page.editUrl}}">Edit this Page</a></div>
+  <!--
+    Removing the edit link until we have these docs on master/rel branches
+            <div class="edit-this-page"><a href="{{page.editUrl}}">Edit this Page</a></div>
+  -->
   {{/if}}
 </div>

diff --git a/docs-antora/ui/supplemental_ui/partials/header-content.hbs b/docs-antora/ui/supplemental_ui/partials/header-content.hbs
deleted file mode 100644 (file)
index 36909f5..0000000
--- a/docs-antora/ui/supplemental_ui/partials/header-content.hbs
+++ /dev/null
@@ -1,48 +0,0 @@
-<header class="header" role="banner">
-  <nav class="navbar">
-    <div class="navbar-brand">
-      <a class="navbar-item" href="{{or site.url (or siteRootUrl siteRootPath)}}">{{site.title}}</a>
-      {{#if env.DOCSEARCH_ENABLED}}
-        <div class="navbar-item">
-          <input id="search-input" type="text" placeholder="Search docs">
-        </div>
-      {{/if}}
-      <button class="navbar-burger" data-target="topbar-nav">
-        <span></span>
-        <span></span>
-        <span></span>
-      </button>
-    </div>
-    <div id="topbar-nav" class="navbar-menu">
-      <div class="navbar-end">
-        <div class="navbar-item has-dropdown is-hoverable">
-          <a class="navbar-link" href="#">Documentation</a>
-          <div class="navbar-dropdown">
-            <a class="navbar-item" href="http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:dig">Documentation Interest Group</a>
-            <a class="navbar-item" href="http://evergreen-ils.org/dokuwiki/doku.php?id=faqs:evergreen_roadmap">Evergreen Roadmap</a>
-            <a class="navbar-item" href="http://wiki.evergreen-ils.org/">Evergreen Wiki</a>
-            <a class="navbar-item" href="https://evergreen-ils.org/eg-documentation/tabular-release-notes/">Tabular Release Notes</a>
-          </div>
-        </div>
-        <div class="navbar-item has-dropdown is-hoverable">
-          <a class="navbar-link" href="#">Downloads</a>
-          <div class="navbar-dropdown">
-            <a class="navbar-item" href="https://evergreen-ils.org/trademark-policy/">Evergreen Downloads</a>
-            <a class="navbar-item" href="https://evergreen-ils.org/opensrf-downloads/">OpenSRF Downloads</a>
-          </div>
-        </div>
-        <div class="navbar-item has-dropdown is-hoverable">
-          <a class="navbar-link" href="#">About Us</a>
-          <div class="navbar-dropdown">
-            <a class="navbar-item" href="https://evergreen-ils.org/about-us/">Overview</a>
-            <a class="navbar-item" href="https://evergreen-ils.org/about-us/annual-reports/">Annual Reports</a>
-            <a class="navbar-item" href="https://evergreen-ils.org/frequently-anticipated-questions/">F.A.Q.</a>
-            <a class="navbar-item" href="https://evergreen-ils.org/code-of-conduct/">Evergreen Event Code of Conduct</a>
-            <a class="navbar-item" href="https://evergreen-ils.org/governance/">Project Governance</a>
-            <a class="navbar-item" href="https://evergreen-ils.org/trademark-policy/">Trademark Policy</a>            
-          </div>
-        </div>
-      </div>
-    </div>
-  </nav>
-</header>

diff --git a/docs-antora/ui/supplemental_ui/css/search.css b/docs-antora/ui/ui-lunr/css/search.css
similarity index 100%
rename from docs-antora/ui/supplemental_ui/css/search.css
rename to docs-antora/ui/ui-lunr/css/search.css

diff --git a/docs-antora/ui/supplemental_ui/js/vendor/lunr.js b/docs-antora/ui/ui-lunr/js/vendor/lunr.js
similarity index 100%
rename from docs-antora/ui/supplemental_ui/js/vendor/lunr.js
rename to docs-antora/ui/ui-lunr/js/vendor/lunr.js

diff --git a/docs-antora/ui/supplemental_ui/js/vendor/search.js b/docs-antora/ui/ui-lunr/js/vendor/search.js
similarity index 100%
rename from docs-antora/ui/supplemental_ui/js/vendor/search.js
rename to docs-antora/ui/ui-lunr/js/vendor/search.js

diff --git a/docs-antora/ui/supplemental_ui/partials/footer-scripts.hbs b/docs-antora/ui/ui-lunr/partials/footer-scripts.hbs
similarity index 100%
rename from docs-antora/ui/supplemental_ui/partials/footer-scripts.hbs
rename to docs-antora/ui/ui-lunr/partials/footer-scripts.hbs

diff --git a/docs-antora/ui/supplemental_ui/partials/head-meta.hbs b/docs-antora/ui/ui-lunr/partials/head-meta.hbs
similarity index 100%
rename from docs-antora/ui/supplemental_ui/partials/head-meta.hbs
rename to docs-antora/ui/ui-lunr/partials/head-meta.hbs