From 12f798ca2cf35b1689684ea70d88b2e7ab2eeb97 Mon Sep 17 00:00:00 2001 From: soulgalore Date: Thu, 28 Dec 2017 23:33:27 +0100 Subject: [PATCH] use _include dir for versions so we can use it on all pages --- docs/_includes/index/box2.md | 14 +++++++------- docs/_includes/index/install.md | 2 +- docs/{ => _includes}/version/browsertime.txt | 0 docs/{ => _includes}/version/chrome-har.txt | 0 docs/{ => _includes}/version/coach.txt | 0 docs/{ => _includes}/version/compare.txt | 0 docs/{ => _includes}/version/pagexray.txt | 0 docs/{ => _includes}/version/sitespeed.io.txt | 0 docs/{ => _includes}/version/throttle.txt | 0 docs/documentation/sitespeed.io/docker/index.md | 2 +- release.sh | 2 +- 11 files changed, 10 insertions(+), 10 deletions(-) rename docs/{ => _includes}/version/browsertime.txt (100%) rename docs/{ => _includes}/version/chrome-har.txt (100%) rename docs/{ => _includes}/version/coach.txt (100%) rename docs/{ => _includes}/version/compare.txt (100%) rename docs/{ => _includes}/version/pagexray.txt (100%) rename docs/{ => _includes}/version/sitespeed.io.txt (100%) rename docs/{ => _includes}/version/throttle.txt (100%) diff --git a/docs/_includes/index/box2.md b/docs/_includes/index/box2.md index 944397756..4ffc50cba 100644 --- a/docs/_includes/index/box2.md +++ b/docs/_includes/index/box2.md @@ -1,10 +1,10 @@ ## Get the latest versions * * * - * [sitespeed.io](/documentation/sitespeed.io/) {% include_relative version/sitespeed.io.txt %} [[Docker](https://hub.docker.com/r/sitespeedio/sitespeed.io/)/[npm](https://www.npmjs.com/package/sitespeed.io)/[changelog](https://github.com/sitespeedio/sitespeed.io/blob/master/CHANGELOG.md)] - * [Browsertime](/documentation/browsertime/) {% include_relative version/browsertime.txt %} [[Docker](https://hub.docker.com/r/sitespeedio/browsertime/)/[npm](https://www.npmjs.com/package/browsertime)/[changelog](https://github.com/sitespeedio/browsertime/blob/master/CHANGELOG.md)] - * [Coach](/documentation/coach/) {% include_relative version/coach.txt %} [[Docker](https://hub.docker.com/r/sitespeedio/coach/)/[npm](https://www.npmjs.com/package/webcoach)/[changelog](https://github.com/sitespeedio/coach/blob/master/CHANGELOG.md)] - * [PageXray](/documentation/pagexray/) {% include_relative version/pagexray.txt %} [[npm](https://www.npmjs.com/package/pagexray)/[changelog](https://github.com/sitespeedio/pagexray/blob/master/CHANGELOG.md)] - * [Compare](https://compare.sitespeed.io/) {% include_relative version/compare.txt %} [[npm](https://www.npmjs.com/package/@sitespeed.io/compare)/[changelog](https://github.com/sitespeedio/compare/blob/master/CHANGELOG.md)] - * [Throttle](/documentation/throttle/) {% include_relative version/throttle.txt %} [[npm](https://www.npmjs.com/package/@sitespeed.io/throttle)/[changelog](https://github.com/sitespeedio/throttle/blob/master/CHANGELOG.md)] - * [Chrome-HAR](/documentation/chrome-har/) {% include_relative version/chrome-har.txt %} [[npm](https://www.npmjs.com/package/chrome-har)/[changelog](https://github.com/sitespeedio/chrome-har/blob/master/CHANGELOG.md)] + * [sitespeed.io](/documentation/sitespeed.io/) {% include version/sitespeed.io.txt %} [[Docker](https://hub.docker.com/r/sitespeedio/sitespeed.io/)/[npm](https://www.npmjs.com/package/sitespeed.io)/[changelog](https://github.com/sitespeedio/sitespeed.io/blob/master/CHANGELOG.md)] + * [Browsertime](/documentation/browsertime/) {% include version/browsertime.txt %} [[Docker](https://hub.docker.com/r/sitespeedio/browsertime/)/[npm](https://www.npmjs.com/package/browsertime)/[changelog](https://github.com/sitespeedio/browsertime/blob/master/CHANGELOG.md)] + * [Coach](/documentation/coach/) {% include version/coach.txt %} [[Docker](https://hub.docker.com/r/sitespeedio/coach/)/[npm](https://www.npmjs.com/package/webcoach)/[changelog](https://github.com/sitespeedio/coach/blob/master/CHANGELOG.md)] + * [PageXray](/documentation/pagexray/) {% include version/pagexray.txt %} [[npm](https://www.npmjs.com/package/pagexray)/[changelog](https://github.com/sitespeedio/pagexray/blob/master/CHANGELOG.md)] + * [Compare](https://compare.sitespeed.io/) {% include version/compare.txt %} [[npm](https://www.npmjs.com/package/@sitespeed.io/compare)/[changelog](https://github.com/sitespeedio/compare/blob/master/CHANGELOG.md)] + * [Throttle](/documentation/throttle/) {% include version/throttle.txt %} [[npm](https://www.npmjs.com/package/@sitespeed.io/throttle)/[changelog](https://github.com/sitespeedio/throttle/blob/master/CHANGELOG.md)] + * [Chrome-HAR](/documentation/chrome-har/) {% include version/chrome-har.txt %} [[npm](https://www.npmjs.com/package/chrome-har)/[changelog](https://github.com/sitespeedio/chrome-har/blob/master/CHANGELOG.md)] diff --git a/docs/_includes/index/install.md b/docs/_includes/index/install.md index 3346f6b01..c1c867455 100644 --- a/docs/_includes/index/install.md +++ b/docs/_includes/index/install.md @@ -4,7 +4,7 @@ Use our [Docker container](https://hub.docker.com/r/sitespeedio/sitespeed.io/) to get an environment with Firefox, Chrome, XVFB and sitespeed.io up and running as fast as you can download them. They work [extremely well]({{site.baseurl}}/documentation/sitespeed.io/performance-dashboard/) together with Graphite/InfluxDB and Grafana. ~~~bash -docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io:{% include_relative version/sitespeed.io.txt %} https://www.sitespeed.io/ +docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %} https://www.sitespeed.io/ ~~~ #### npm diff --git a/docs/version/browsertime.txt b/docs/_includes/version/browsertime.txt similarity index 100% rename from docs/version/browsertime.txt rename to docs/_includes/version/browsertime.txt diff --git a/docs/version/chrome-har.txt b/docs/_includes/version/chrome-har.txt similarity index 100% rename from docs/version/chrome-har.txt rename to docs/_includes/version/chrome-har.txt diff --git a/docs/version/coach.txt b/docs/_includes/version/coach.txt similarity index 100% rename from docs/version/coach.txt rename to docs/_includes/version/coach.txt diff --git a/docs/version/compare.txt b/docs/_includes/version/compare.txt similarity index 100% rename from docs/version/compare.txt rename to docs/_includes/version/compare.txt diff --git a/docs/version/pagexray.txt b/docs/_includes/version/pagexray.txt similarity index 100% rename from docs/version/pagexray.txt rename to docs/_includes/version/pagexray.txt diff --git a/docs/version/sitespeed.io.txt b/docs/_includes/version/sitespeed.io.txt similarity index 100% rename from docs/version/sitespeed.io.txt rename to docs/_includes/version/sitespeed.io.txt diff --git a/docs/version/throttle.txt b/docs/_includes/version/throttle.txt similarity index 100% rename from docs/version/throttle.txt rename to docs/_includes/version/throttle.txt diff --git a/docs/documentation/sitespeed.io/docker/index.md b/docs/documentation/sitespeed.io/docker/index.md index 5d70451ac..201fef75e 100644 --- a/docs/documentation/sitespeed.io/docker/index.md +++ b/docs/documentation/sitespeed.io/docker/index.md @@ -37,7 +37,7 @@ We lock down the browsers to specific versions for maximum compatibility and sta The simplest way to run using Chrome: ~~~bash -docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io -b chrome https://www.sitespeed.io/ +docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %} -b chrome https://www.sitespeed.io/ ~~~ Note: The shm-size increases the memory for the GPU (default is 64mb and that is too small) see [https://github.com/elgalu/docker-selenium/issues/20](https://github.com/elgalu/docker-selenium/issues/20). diff --git a/release.sh b/release.sh index 49b68125f..79def7f40 100755 --- a/release.sh +++ b/release.sh @@ -21,7 +21,7 @@ docker push sitespeedio/sitespeed.io:$PACKAGE_VERSION docker push sitespeedio/sitespeed.io:latest # Update to latet version in the docs -bin/sitespeed.js --version | tr -d '\n' > docs/version/sitespeed.io.txt +bin/sitespeed.js --version | tr -d '\n' > docs/_includes/version/sitespeed.io.txt # Generate the help for the docs bin/sitespeed.js --help > docs/documentation/sitespeed.io/configuration/config.md