From 6f89f48d42f901ed00921f9526786d74bf05efdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20G=C3=A9raud?= Date: Thu, 15 Dec 2016 00:30:07 +0100 Subject: [PATCH] feat: Improve documentation by providing multi-pages fix gravitee-io/issues#348 --- .gitignore | 2 + 404.md | 6 + Dockerfile | 2 +- Dockerfile-build | 37 + Gemfile | 12 + Gemfile.lock | 161 + Jenkinsfile | 12 +- _config.yml | 117 + _data/alerts.yml | 15 + _data/sidebars/apim_sidebar.yml | 172 + _data/strings.yml | 5 + _data/topnav.yml | 46 + _includes/archive.html | 15 + _includes/callout.html | 1 + _includes/custom/sidebarconfigs.html | 11 + _includes/disqus.html | 16 + _includes/feedback.html | 1 + _includes/footer.html | 19 + _includes/google_analytics.html | 6 + _includes/head.html | 40 + _includes/head_print.html | 33 + _includes/image.html | 1 + _includes/important.html | 1 + _includes/initialize_shuffle.html | 130 + _includes/inline_image.html | 1 + _includes/links.html | 44 + _includes/note.html | 1 + _includes/sidebar.html | 56 + _includes/taglogic.html | 32 + _includes/tip.html | 1 + _includes/toc.html | 21 + _includes/topnav.html | 62 + _includes/warning.html | 1 + _layouts/default.html | 80 + _layouts/default_print.html | 25 + _layouts/none.html | 3 + _layouts/page.html | 70 + _layouts/page_print.html | 15 + css/asciidoc-pygments.css | 38 + css/bootstrap.min.css | 5 + css/customstyles.css | 1218 ++++ css/font-awesome.min.css | 4 + css/fonts/FontAwesome.otf | Bin 0 -> 93888 bytes css/fonts/fontawesome-webfont.eot | Bin 0 -> 60767 bytes css/fonts/fontawesome-webfont.svg | 565 ++ css/fonts/fontawesome-webfont.ttf | Bin 0 -> 122092 bytes css/fonts/fontawesome-webfont.woff | Bin 0 -> 71508 bytes css/fonts/fontawesome-webfont.woff2 | Bin 0 -> 56780 bytes css/lavish-bootstrap.css | 5898 +++++++++++++++++ css/modern-business.css | 93 + css/printstyles.css | 160 + css/syntax.css | 60 + css/theme-blue.css | 103 + css/theme-bluegrey.css | 117 + css/theme-dark.css | 99 + css/theme-green.css | 99 + fonts/FontAwesome.otf | Bin 0 -> 85908 bytes fonts/fontawesome-webfont.eot | Bin 0 -> 56006 bytes fonts/fontawesome-webfont.svg | 520 ++ fonts/fontawesome-webfont.ttf | Bin 0 -> 112160 bytes fonts/fontawesome-webfont.woff | Bin 0 -> 65452 bytes fonts/glyphicons-halflings-regular.eot | Bin 0 -> 20127 bytes fonts/glyphicons-halflings-regular.svg | 288 + fonts/glyphicons-halflings-regular.ttf | Bin 0 -> 45404 bytes fonts/glyphicons-halflings-regular.woff | Bin 0 -> 23424 bytes fonts/glyphicons-halflings-regular.woff2 | Bin 0 -> 18028 bytes images/GRAVITEE_LOGOclairblcsstxt.png | Bin 0 -> 18156 bytes .../graviteeio-gateway-architecture.png | Bin .../graviteeio-gateway-internal.png | Bin .../graviteeio-global-architecture.png | Bin .../graviteeio-platform-architecture.png | Bin .../architecture_overview.png | Bin images/authorizegithubscreen2.png | Bin 0 -> 76388 bytes images/authorizeongithub.png | Bin 0 -> 22571 bytes .../asciidoc/images => images}/docker.svg | 0 images/favicon.ico | Bin 0 -> 1150 bytes .../images => images}/graviteeio-app-keys.png | Bin .../graviteeio-create-api-options.png | Bin .../graviteeio-create-api-swagger-1.png | Bin .../graviteeio-create-api-swagger-2.png | Bin .../graviteeio-create-api-swagger-3.png | Bin .../graviteeio-create-api-swagger-4.png | Bin .../graviteeio-create-first-api-1.png | Bin .../graviteeio-create-first-api-2.png | Bin .../graviteeio-create-first-api-3.png | Bin .../graviteeio-create-first-app.png | Bin .../graviteeio-first-api.png | Bin .../graviteeio-first-app.png | Bin .../graviteeio-subscribe-api.png | Bin .../asciidoc/images => images}/redhat.svg | 0 index.adoc | 12 + js/customscripts.js | 55 + js/jekyll-search.js | 1 + js/jquery.ba-throttle-debounce.min.js | 9 + js/jquery.localScroll.min.js | 7 + js/jquery.navgoco.min.js | 8 + js/jquery.scrollTo.min.js | 7 + js/jquery.shuffle.min.js | 1588 +++++ js/mydoc_scroll.html | 240 + js/toc.js | 82 + licenses/LICENSE | 21 + licenses/LICENSE-BSD-NAVGOCO.txt | 27 + pages/apim/changelog.adoc | 7 + .../apim}/dev-guide/dev-guide-plugins.adoc | 22 +- .../apim}/dev-guide/dev-guide-policies.adoc | 10 +- .../installation-guide-configuration.adoc | 64 +- .../installation-guide-docker.adoc | 23 +- .../installation-guide-gateway.adoc | 17 +- ...nstallation-guide-management-rest-api.adoc | 23 +- .../installation-guide-management-webui.adoc | 19 +- .../installation-guide-quickstart.adoc | 0 .../installation-guide-rpm.adoc | 0 .../installation-guide-zip.adoc | 0 .../installation-guide.adoc | 0 pages/apim/overview/architecture.adoc | 15 + pages/apim/overview/components.adoc | 29 + pages/apim/overview/concepts.adoc | 24 + pages/apim/overview/introduction.adoc | 30 + pages/apim/overview/plugins.adoc | 71 + pages/apim/overview/why.adoc | 23 + pages/apim/quickstart/api-consumer.adoc | 6 + .../apim}/quickstart/api-publisher.adoc | 17 +- .../consumer/developer-create-account.adoc | 4 + .../user-guide/consumer/developer-manage.adoc | 10 + .../user-guide/consumer/developer-portal.adoc | 19 +- .../consumer/developer-subscribe.adoc | 5 + .../user-guide/publisher/manage-api.adoc | 59 +- .../user-guide/publisher/manage-members.adoc | 27 + .../publisher/plans-subscriptions.adoc | 5 + .../publisher/policies/policies-overview.adoc | 7 + .../publisher/policies/policy-apikey.adoc | 6 + .../publisher/policies/policy-cache.adoc | 6 + .../publisher/policies/policy-cors.adoc | 6 + .../policies/policy-dynamic-routing.adoc | 6 + .../publisher/policies/policy-groovy.adoc | 6 + .../publisher/policies/policy-html-json.adoc | 6 + .../policies/policy-ipfiltering.adoc | 6 + .../policies/policy-json-to-json.adoc | 6 + .../publisher/policies/policy-jwt.adoc | 6 + .../publisher/policies/policy-mock.adoc | 6 + .../publisher/policies/policy-oauth2.adoc | 6 + .../publisher/policies/policy-ratelimit.adoc | 6 + .../policy-request-content-limit.adoc | 6 + .../policies/policy-resource-filtering.adoc | 6 + .../policies/policy-rest-to-soap.adoc | 6 + .../policies/policy-transform-headers.adoc | 6 + .../policy-transform-queryparameters.adoc | 6 + .../publisher/policies/policy-xml-json.adoc | 6 + .../publisher/policies/policy-xslt.adoc | 6 + .../publisher/publish-documentation.adoc | 13 + pom.xml | 122 - search.json | 33 + sitemap.xml | 24 + src/main/asciidoc/Guardfile | 19 - src/main/asciidoc/dev-guide/dev-guide.adoc | 10 - src/main/asciidoc/docinfo.html | 392 -- src/main/asciidoc/index-docinfo-footer.html | 4 - src/main/asciidoc/index-docinfo.html | 20 - src/main/asciidoc/index-docinfo.xml | 12 - src/main/asciidoc/index.adoc | 13 - src/main/asciidoc/overview.adoc | 171 - .../asciidoc/quickstart/api-consumer.adoc | 3 - src/main/asciidoc/quickstart/quick-start.adoc | 5 - .../publisher/policies/policies-overview.adoc | 62 - .../publisher/policies/policy-apikey.adoc | 2 - .../publisher/policies/policy-cache.adoc | 2 - .../publisher/policies/policy-cors.adoc | 2 - .../policies/policy-dynamic-routing.adoc | 2 - .../publisher/policies/policy-groovy.adoc | 2 - .../publisher/policies/policy-html-json.adoc | 2 - .../policies/policy-ipfiltering.adoc | 2 - .../policies/policy-json-to-json.adoc | 2 - .../publisher/policies/policy-jwt.adoc | 2 - .../publisher/policies/policy-mock.adoc | 2 - .../publisher/policies/policy-oauth2.adoc | 2 - .../publisher/policies/policy-ratelimit.adoc | 2 - .../policy-request-content-limit.adoc | 2 - .../policies/policy-resource-filtering.adoc | 2 - .../policies/policy-rest-to-soap.adoc | 2 - .../policies/policy-transform-headers.adoc | 2 - .../policy-transform-queryparameters.adoc | 2 - .../publisher/policies/policy-xml-json.adoc | 2 - .../publisher/policies/policy-xslt.adoc | 2 - src/main/asciidoc/user-guide/user-guide.adoc | 5 - src/main/assembly/distribution.xml | 44 - 185 files changed, 13154 insertions(+), 1083 deletions(-) create mode 100644 404.md create mode 100644 Dockerfile-build create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 _config.yml create mode 100644 _data/alerts.yml create mode 100644 _data/sidebars/apim_sidebar.yml create mode 100644 _data/strings.yml create mode 100644 _data/topnav.yml create mode 100644 _includes/archive.html create mode 100644 _includes/callout.html create mode 100644 _includes/custom/sidebarconfigs.html create mode 100644 _includes/disqus.html create mode 100644 _includes/feedback.html create mode 100755 _includes/footer.html create mode 100644 _includes/google_analytics.html create mode 100644 _includes/head.html create mode 100644 _includes/head_print.html create mode 100644 _includes/image.html create mode 100644 _includes/important.html create mode 100644 _includes/initialize_shuffle.html create mode 100644 _includes/inline_image.html create mode 100644 _includes/links.html create mode 100644 _includes/note.html create mode 100644 _includes/sidebar.html create mode 100644 _includes/taglogic.html create mode 100644 _includes/tip.html create mode 100644 _includes/toc.html create mode 100644 _includes/topnav.html create mode 100644 _includes/warning.html create mode 100644 _layouts/default.html create mode 100644 _layouts/default_print.html create mode 100644 _layouts/none.html create mode 100644 _layouts/page.html create mode 100644 _layouts/page_print.html create mode 100644 css/asciidoc-pygments.css create mode 100755 css/bootstrap.min.css create mode 100644 css/customstyles.css create mode 100644 css/font-awesome.min.css create mode 100644 css/fonts/FontAwesome.otf create mode 100644 css/fonts/fontawesome-webfont.eot create mode 100644 css/fonts/fontawesome-webfont.svg create mode 100644 css/fonts/fontawesome-webfont.ttf create mode 100644 css/fonts/fontawesome-webfont.woff create mode 100644 css/fonts/fontawesome-webfont.woff2 create mode 100644 css/lavish-bootstrap.css create mode 100755 css/modern-business.css create mode 100644 css/printstyles.css create mode 100644 css/syntax.css create mode 100644 css/theme-blue.css create mode 100644 css/theme-bluegrey.css create mode 100644 css/theme-dark.css create mode 100644 css/theme-green.css create mode 100644 fonts/FontAwesome.otf create mode 100644 fonts/fontawesome-webfont.eot create mode 100644 fonts/fontawesome-webfont.svg create mode 100644 fonts/fontawesome-webfont.ttf create mode 100644 fonts/fontawesome-webfont.woff create mode 100644 fonts/glyphicons-halflings-regular.eot create mode 100644 fonts/glyphicons-halflings-regular.svg create mode 100644 fonts/glyphicons-halflings-regular.ttf create mode 100644 fonts/glyphicons-halflings-regular.woff create mode 100644 fonts/glyphicons-halflings-regular.woff2 create mode 100644 images/GRAVITEE_LOGOclairblcsstxt.png rename {src/main/asciidoc/images => images}/architecture/graviteeio-gateway-architecture.png (100%) rename {src/main/asciidoc/images => images}/architecture/graviteeio-gateway-internal.png (100%) rename {src/main/asciidoc/images => images}/architecture/graviteeio-global-architecture.png (100%) rename {src/main/asciidoc/images => images}/architecture/graviteeio-platform-architecture.png (100%) rename {src/main/asciidoc/images => images}/architecture_overview.png (100%) create mode 100644 images/authorizegithubscreen2.png create mode 100644 images/authorizeongithub.png rename {src/main/asciidoc/images => images}/docker.svg (100%) create mode 100644 images/favicon.ico rename {src/main/asciidoc/images => images}/graviteeio-app-keys.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-api-options.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-api-swagger-1.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-api-swagger-2.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-api-swagger-3.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-api-swagger-4.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-first-api-1.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-first-api-2.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-first-api-3.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-create-first-app.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-first-api.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-first-app.png (100%) rename {src/main/asciidoc/images => images}/graviteeio-subscribe-api.png (100%) rename {src/main/asciidoc/images => images}/redhat.svg (100%) create mode 100644 index.adoc create mode 100644 js/customscripts.js create mode 100644 js/jekyll-search.js create mode 100644 js/jquery.ba-throttle-debounce.min.js create mode 100644 js/jquery.localScroll.min.js create mode 100755 js/jquery.navgoco.min.js create mode 100644 js/jquery.scrollTo.min.js create mode 100644 js/jquery.shuffle.min.js create mode 100644 js/mydoc_scroll.html create mode 100644 js/toc.js create mode 100644 licenses/LICENSE create mode 100644 licenses/LICENSE-BSD-NAVGOCO.txt create mode 100644 pages/apim/changelog.adoc rename {src/main/asciidoc => pages/apim}/dev-guide/dev-guide-plugins.adoc (93%) rename {src/main/asciidoc => pages/apim}/dev-guide/dev-guide-policies.adoc (97%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-configuration.adoc (97%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-docker.adoc (93%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-gateway.adoc (92%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-management-rest-api.adoc (79%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-management-webui.adoc (87%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-quickstart.adoc (100%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-rpm.adoc (100%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide-zip.adoc (100%) rename {src/main/asciidoc => pages/apim}/installation-guide/installation-guide.adoc (100%) create mode 100644 pages/apim/overview/architecture.adoc create mode 100644 pages/apim/overview/components.adoc create mode 100644 pages/apim/overview/concepts.adoc create mode 100644 pages/apim/overview/introduction.adoc create mode 100644 pages/apim/overview/plugins.adoc create mode 100644 pages/apim/overview/why.adoc create mode 100644 pages/apim/quickstart/api-consumer.adoc rename {src/main/asciidoc => pages/apim}/quickstart/api-publisher.adoc (85%) create mode 100644 pages/apim/user-guide/consumer/developer-create-account.adoc create mode 100644 pages/apim/user-guide/consumer/developer-manage.adoc rename {src/main/asciidoc => pages/apim}/user-guide/consumer/developer-portal.adoc (66%) create mode 100644 pages/apim/user-guide/consumer/developer-subscribe.adoc rename {src/main/asciidoc => pages/apim}/user-guide/publisher/manage-api.adoc (54%) create mode 100644 pages/apim/user-guide/publisher/manage-members.adoc create mode 100644 pages/apim/user-guide/publisher/plans-subscriptions.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policies-overview.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-apikey.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-cache.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-cors.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-dynamic-routing.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-groovy.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-html-json.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-ipfiltering.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-json-to-json.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-jwt.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-mock.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-oauth2.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-ratelimit.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-request-content-limit.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-resource-filtering.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-rest-to-soap.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-transform-headers.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-transform-queryparameters.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-xml-json.adoc create mode 100644 pages/apim/user-guide/publisher/policies/policy-xslt.adoc create mode 100644 pages/apim/user-guide/publisher/publish-documentation.adoc delete mode 100644 pom.xml create mode 100644 search.json create mode 100644 sitemap.xml delete mode 100644 src/main/asciidoc/Guardfile delete mode 100644 src/main/asciidoc/dev-guide/dev-guide.adoc delete mode 100644 src/main/asciidoc/docinfo.html delete mode 100644 src/main/asciidoc/index-docinfo-footer.html delete mode 100644 src/main/asciidoc/index-docinfo.html delete mode 100644 src/main/asciidoc/index-docinfo.xml delete mode 100644 src/main/asciidoc/index.adoc delete mode 100644 src/main/asciidoc/overview.adoc delete mode 100644 src/main/asciidoc/quickstart/api-consumer.adoc delete mode 100644 src/main/asciidoc/quickstart/quick-start.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policies-overview.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-apikey.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-cache.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-cors.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-dynamic-routing.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-groovy.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-html-json.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-ipfiltering.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-json-to-json.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-jwt.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-mock.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-oauth2.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-ratelimit.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-request-content-limit.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-resource-filtering.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-rest-to-soap.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-transform-headers.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-transform-queryparameters.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-xml-json.adoc delete mode 100644 src/main/asciidoc/user-guide/publisher/policies/policy-xslt.adoc delete mode 100644 src/main/asciidoc/user-guide/user-guide.adoc delete mode 100644 src/main/assembly/distribution.xml diff --git a/.gitignore b/.gitignore index 0beab6581..2bf8a7546 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,5 @@ build/ .settings/ .classpath .project +_site/ +.jekyll-metadata diff --git a/404.md b/404.md new file mode 100644 index 000000000..a7b58c002 --- /dev/null +++ b/404.md @@ -0,0 +1,6 @@ +--- +title: "Page Not Found" +search: exclude +--- + +Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct. diff --git a/Dockerfile b/Dockerfile index a75324ef8..f37489607 100644 --- a/Dockerfile +++ b/Dockerfile @@ -13,5 +13,5 @@ FROM graviteeio/httpd:latest MAINTAINER Gravitee Team -COPY target/generated-docs/htmlsingle /var/www/html/ +COPY _site /var/www/html/ CMD ["/usr/sbin/httpd", "-DFOREGROUND"] \ No newline at end of file diff --git a/Dockerfile-build b/Dockerfile-build new file mode 100644 index 000000000..87a5aefa9 --- /dev/null +++ b/Dockerfile-build @@ -0,0 +1,37 @@ +#------------------------------------------------------------------------------- +# Copyright (C) 2015 The Gravitee team (http://gravitee.io) +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#------------------------------------------------------------------------------- +FROM ruby:latest +MAINTAINER Gravitee Team + +RUN apt-get clean \ + && mv /var/lib/apt/lists /var/lib/apt/lists.broke \ + && mkdir -p /var/lib/apt/lists/partial + +RUN apt-get update + +RUN apt-get install -y \ + node \ + python-pygments \ + && apt-get clean \ + && rm -rf /var/lib/apt/lists/ + +WORKDIR /tmp +ADD Gemfile /tmp/ +ADD Gemfile.lock /tmp/ +RUN bundle install + +VOLUME /src +EXPOSE 4000 + +WORKDIR /src +ENTRYPOINT ["jekyll"] \ No newline at end of file diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..121000a13 --- /dev/null +++ b/Gemfile @@ -0,0 +1,12 @@ +source "https://rubygems.org" + + +gem "jekyll", "3.3.1" + + +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.6" + gem 'github-pages', '~> 106' + gem 'jekyll-asciidoc', '~> 2.0.1' + gem 'pygments.rb', '~> 1.0.0' +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 000000000..a627e25d8 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,161 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.7) + i18n (~> 0.7) + json (~> 1.7, >= 1.7.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.4.0) + asciidoctor (1.5.5) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + ethon (0.10.1) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.10.0) + multipart-post (>= 1.2, < 3) + ffi (1.9.14) + forwardable-extended (2.6.0) + gemoji (2.1.0) + github-pages (106) + activesupport (= 4.2.7) + github-pages-health-check (= 1.2.0) + jekyll (= 3.3.1) + jekyll-avatar (= 0.4.2) + jekyll-coffeescript (= 1.0.1) + jekyll-feed (= 0.8.0) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 2.2.0) + jekyll-mentions (= 1.2.0) + jekyll-paginate (= 1.1.0) + jekyll-redirect-from (= 0.11.0) + jekyll-relative-links (= 0.2.1) + jekyll-sass-converter (= 1.3.0) + jekyll-seo-tag (= 2.1.0) + jekyll-sitemap (= 0.12.0) + jekyll-swiss (= 0.4.0) + jemoji (= 0.7.0) + kramdown (= 1.11.1) + liquid (= 3.0.6) + listen (= 3.0.6) + mercenary (~> 0.3) + minima (= 2.0.0) + rouge (= 1.11.1) + terminal-table (~> 1.4) + github-pages-health-check (1.2.0) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 1.4) + typhoeus (~> 0.7) + html-pipeline (2.4.2) + activesupport (>= 2) + nokogiri (>= 1.4) + i18n (0.7.0) + jekyll (3.3.1) + addressable (~> 2.4) + colorator (~> 1.0) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-asciidoc (2.0.1) + asciidoctor (>= 1.5.0) + jekyll (>= 2.3.0) + jekyll-avatar (0.4.2) + jekyll (~> 3.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-feed (0.8.0) + jekyll (~> 3.3) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (2.2.0) + jekyll (~> 3.1) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.2.0) + activesupport (~> 4.0) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-redirect-from (0.11.0) + jekyll (>= 2.0) + jekyll-relative-links (0.2.1) + jekyll (~> 3.3) + jekyll-sass-converter (1.3.0) + sass (~> 3.2) + jekyll-seo-tag (2.1.0) + jekyll (~> 3.3) + jekyll-sitemap (0.12.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-watch (1.5.0) + listen (~> 3.0, < 3.1) + jemoji (0.7.0) + activesupport (~> 4.0) + gemoji (~> 2.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + json (1.8.3) + kramdown (1.11.1) + liquid (3.0.6) + listen (3.0.6) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.1.0) + minima (2.0.0) + minitest (5.10.1) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.8.1) + mini_portile2 (~> 2.1.0) + octokit (4.6.2) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.14.0) + forwardable-extended (~> 2.6) + posix-spawn (0.3.12) + public_suffix (1.5.3) + pygments.rb (1.0.0) + posix-spawn (~> 0.3.6) + yajl-ruby (~> 1.2) + rb-fsevent (0.9.8) + rb-inotify (0.9.7) + ffi (>= 0.5.0) + rouge (1.11.1) + safe_yaml (1.0.4) + sass (3.4.22) + sawyer (0.8.1) + addressable (>= 2.3.5, < 2.6) + faraday (~> 0.8, < 1.0) + terminal-table (1.7.3) + unicode-display_width (~> 1.1.1) + thread_safe (0.3.5) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.2) + thread_safe (~> 0.1) + unicode-display_width (1.1.2) + yajl-ruby (1.3.0) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages (~> 106) + jekyll (= 3.3.1) + jekyll-asciidoc (~> 2.0.1) + jekyll-feed (~> 0.6) + pygments.rb (~> 1.0.0) + +BUNDLED WITH + 1.13.6 diff --git a/Jenkinsfile b/Jenkinsfile index 48a6a8541..426be07be 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -1,16 +1,14 @@ node() { + sh "rm -rf *" + sh "rm -rf .*" stage("Checkout") { checkout scm } - stage("Build") { - def mvnHome = tool 'MVN33' - def javaHome = tool 'JDK 8' - withEnv(["PATH+MAVEN=${mvnHome}/bin", - "JAVA_HOME=${javaHome}"]) { - sh "mvn clean package" - } + stage("Jekyll Build") { + sh "docker build --no-cache -t gravitee.io/jekyll -f Dockerfile-build ." + sh "docker run --rm -v '${env.WORKSPACE}:/src' gravitee.io/jekyll build" } stage("Docker Build & Push") { diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..a89caa29d --- /dev/null +++ b/_config.yml @@ -0,0 +1,117 @@ + +output: web +# this property is useful for conditional filtering of content that is separate from the PDF. + +topnav_title: Gravitee.io +# this appears on the top navigation bar next to the home button + +site_title: Gravitee.io documentation +# this appears in the html browser tab for the site title (seen mostly by search engines, not users) + +company_name: GraviteeSource +# this appears in the footer + +github_editme_path: gravitee-io/gravitee-docs/blob/pages/ +# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. + +disqus_shortname: +# if you're using disqus for comments, add the shortname here. if not, leave this value blank. + +host: 127.0.0.1 +# the preview server used. Leave as is. +port: 4000 +# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006. + +exclude: + - .idea/ + - .gitignore + - README.adoc + - CONTRIBUTING.adoc + - src/ +# these are the files and directories that jekyll will exclude from the build + +feedback_subject_line: +feedback_email: +# used as a contact email for the Feedback link in the top navigation bar +feedback_disable: true +# if you uncomment the previous line, the Feedback link gets removed +# feedback_text: "Need help?" +# if you uncomment the previous line, it changes the Feedback text +# feedback_link: "http://helpy.io/" +# if you uncomment the previous line, it changes where the feedback link points to + +highlighter: rouge +# library used for syntax highlighting + +#markdown: kramdown +#kramdown: +# input: GFM +# auto_ids: true +# hard_wrap: false +# syntax_highlighter: rouge + +# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways + +collections: + tooltips: + output: true +# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true + +defaults: + - + scope: + path: "" + type: "pages" + values: + layout: "page" + comments: true + search: true + sidebar: home_sidebar +# - +# scope: +# path: "" +# type: "tooltips" +# values: +# layout: "page" +# comments: true +# search: true +# tooltip: true +# +# - +# scope: +# path: "" +# type: "posts" +# values: +# layout: "post" +# comments: true +# search: true +# sidebar: home_sidebar + +# these are defaults used for the frontmatter for these file types + +sidebars: +- apim_sidebar +- mydoc_sidebar +- product1_sidebar +- product2_sidebar +- other + +description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features." +# the description is used in the feed.xml file + +# needed for sitemap.xml file only +url: https://docs.gravitee.io + +asciidoc: {} +asciidoctor: + base_dir: :docdir + safe: unsafe + attributes: + - doctype=book + - idseparator=_ + - icons=font + - allow-uri-read=true + - imagesdir=/images + - source-highlighter=pygments + - stylesdir=css + diff --git a/_data/alerts.yml b/_data/alerts.yml new file mode 100644 index 000000000..157e1622b --- /dev/null +++ b/_data/alerts.yml @@ -0,0 +1,15 @@ +tip: '