Update docs for google pages (#180)

* Update docs README.md for installation steps * Update base url to point to the pages instance * Update github url to point to correct repo
pinterest · Nov 5, 2024 · 2f2ae07 · 2f2ae07
1 parent 9fbd944
commit 2f2ae07
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 24 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,7 @@
-Mojito Github pages 
-====
+# Mojito Github pages 
 
-Install `jekyll` with `sudo gem install jekyll` and run the site locally `jekyll serve`
+## Installation
+1. Install [jekyll](https://jekyllrb.com/docs/installation/) 
+
+## Running locally
+1. Run the site locally with `jekyll serve`
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -11,8 +11,9 @@ email: [email protected]
 description: > # this means to ignore newlines until "baseurl:"
   An open source automation platform that enables continuous localization for software development
 baseurl: "" # the subpath of your site, e.g. /blog
-url: "https://www.mojito.global/" # the base hostname & protocol for your site
+url: https://pinterest.github.io/mojito/ # the base hostname & protocol for your site
 mojito_green: <span><font color="green">mojito</font><span>
+github_url: https://github.com/pinterest/mojito
 github_username:  mojito
 # Build settings
 markdown: kramdown

diff --git a/docs/_docs/guides/002-install_springboot3.md b/docs/_docs/guides/002-install_springboot3.md
@@ -148,7 +148,7 @@ Depending on the file size that will be processed, it might be required to incre
 max_allowed_packet = 256M
 ```
 
-If using a older version of MySQL, there is a [known issue](https://github.com/box/mojito/issues/120) when creating the schema. One workaround is to use `utf8`
+If using a older version of MySQL, there is a [known issue]({{site.github_url}}/issues/120) when creating the schema. One workaround is to use `utf8`
 instead `utf8mb4` but it has its limitation in term of character support.
 
 We recommand to run both MySQL and the Java service using `UTC` timezone (or a least make sure they both the same timezone). To set

diff --git a/docs/_docs/guides/open-source-contributors.md b/docs/_docs/guides/open-source-contributors.md
@@ -188,7 +188,7 @@ l10n.org.quartz.dataSource.myDS.URL=jdbc:mysql://localhost:3306/mojito_dev?chara
 Now the basic setup is done the project can be built
 
 ```sh
-git clone https://github.com/box/mojito.git ${PROJECT_DIR}
+git clone {{ site.github_url }}.git ${PROJECT_DIR}
 cd ${PROJECT_DIR}
 git config blame.ignoreRevsFile .git-blame-ignore-revs
 mvn clean install -DskipTests=true

diff --git a/docs/_docs/refs/configurations.md b/docs/_docs/refs/configurations.md
@@ -98,7 +98,7 @@ Depending on the file size that will be processed, it might be required to incre
     max_allowed_packet = 256M
 
 
-If using a older version of MySQL, there is a [known issue](https://github.com/box/mojito/issues/120) when creating the schema. One workaround is to use `utf8`
+If using a older version of MySQL, there is a [known issue]({{ site.github_url }}/issues/120) when creating the schema. One workaround is to use `utf8`
 instead `utf8mb4` but it has its limitation in term of character support.
 
 

diff --git a/docs/_includes/banner.html b/docs/_includes/banner.html
@@ -3,10 +3,10 @@
         <h1 class="title">{{ site.title }}</h1>
         <p class="tag-line">An automation platform that enables continuous localization</p>
         <div>
-            <a class="page-link" href="{{site.url }}/docs/guides/getting-started/">
+            <a class="page-link" href="{{ site.url }}/docs/guides/getting-started/">
                 <button class="btn">Getting Started</button>
             </a>
-            <a class="page-link" href="https://github.com/box/mojito/releases">
+            <a class="page-link" href="{{ site.github_url }}/releases">
                 <button class="btn">Download</button>
             </a>
         </div>

diff --git a/docs/_includes/header.html b/docs/_includes/header.html
@@ -14,7 +14,7 @@
       <div class="trigger">
         <a class="page-link" href="{{site.url }}/docs/guides/getting-started/">Getting Started</a>
         <a class="page-link" href="{{site.url }}/docs/">Documentation</a>
-        <a class="page-link" href="https://github.com/box/mojito">GitHub</a>
+        <a class="page-link" href="{{ site.github_url }}">GitHub</a>
         <span class="site-search">
           <input type="text" id="algolia-doc-search">
         </span>

diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -1,10 +1,8 @@
 <!DOCTYPE html>
 <html>
-
   {% include head.html %}
 
   <body>
-
     {% include header.html %}
 
     {% if page.banner %}
@@ -13,16 +11,6 @@
 
     {{ content }}
 
-<!--
-    <div class="page-content">
-      <div class="wrapper">
-
-      </div>
-    </div>
--->
-
     {% include footer.html %}
-
   </body>
-
 </html>
diff --git a/docs/index.html b/docs/index.html
@@ -5,10 +5,10 @@
 ---
 {% for section in site.data.sections %}
   {% if section.type == 'vertical' %}
-    {% include section-vertical.html sectionClass=section.class sectionTitle=section.title sectionDescription= section.description screenshotContent=section.screenshotContent flipped=section.flipped %}
+    {% include section-vertical.html sectionClass=section.class sectionTitle=section.title sectionDescription=section.description screenshotContent=section.screenshotContent flipped=section.flipped %}
 
   {% else %}
-    {% include section.html sectionClass=section.class sectionTitle=section.title sectionDescription= section.description screenshotContent=section.screenshotContent flipped=section.flipped %}
+    {% include section.html sectionClass=section.class sectionTitle=section.title sectionDescription=section.description screenshotContent=section.screenshotContent flipped=section.flipped %}
   {% endif %}
 
 {% endfor %}