From 2f2ae07612839fe0c2f260f0939aafdef05cc75b Mon Sep 17 00:00:00 2001 From: byronantak Date: Tue, 5 Nov 2024 14:31:01 +0000 Subject: [PATCH] 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 --- docs/README.md | 9 ++++++--- docs/_config.yml | 3 ++- docs/_docs/guides/002-install_springboot3.md | 2 +- docs/_docs/guides/open-source-contributors.md | 2 +- docs/_docs/refs/configurations.md | 2 +- docs/_includes/banner.html | 4 ++-- docs/_includes/header.html | 2 +- docs/_layouts/default.html | 12 ------------ docs/index.html | 4 ++-- 9 files changed, 16 insertions(+), 24 deletions(-) diff --git a/docs/README.md b/docs/README.md index 85f44d187b..631e1e6214 100644 --- 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` \ No newline at end of file +## Installation +1. Install [jekyll](https://jekyllrb.com/docs/installation/) + +## Running locally +1. Run the site locally with `jekyll serve` \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index a9b5b24ace..4e7c761557 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -11,8 +11,9 @@ email: mojito-global@googlegroups.com 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: mojito +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 index 3a0247b399..a55bbff46e 100644 --- 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 index c8684c9f7c..67d22c0e55 100644 --- 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 index 3eabc5fbe1..c2d99f7bf4 100644 --- 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 index e7aa0c6138..f4b9ab2361 100644 --- a/docs/_includes/banner.html +++ b/docs/_includes/banner.html @@ -3,10 +3,10 @@

{{ site.title }}

An automation platform that enables continuous localization

- + - +
diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 9bb9d78946..d8a73d115e 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -14,7 +14,7 @@
Getting Started Documentation - GitHub + GitHub diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index e2b41443e3..37362895bd 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -1,10 +1,8 @@ - {% include head.html %} - {% include header.html %} {% if page.banner %} @@ -13,16 +11,6 @@ {{ content }} - - {% include footer.html %} - - diff --git a/docs/index.html b/docs/index.html index d5e25271f9..007058819d 100644 --- 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 %}