From 7e5b286bb0a5e3aef82bfdb4494befab21f1a079 Mon Sep 17 00:00:00 2001 From: Torsten Sommer Date: Fri, 12 Jul 2019 09:06:56 +0200 Subject: [PATCH] Rename fmi_specification.adoc to index.adoc (#592) to follow Asciidoctor best practices and simplify deployment --- .circleci/config.yml | 5 ++--- CONTRIBUTING.adoc | 6 +++--- docs/{fmi_specification.adoc => index.adoc} | 0 3 files changed, 5 insertions(+), 6 deletions(-) rename docs/{fmi_specification.adoc => index.adoc} (100%) diff --git a/.circleci/config.yml b/.circleci/config.yml index a75a2cbd4..4aab0d850 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -18,7 +18,7 @@ jobs: python .circleci/validate_xml.py - run: name: Generate HTML - command: docker run -v ~/project/:/documents/ --name asciidoc-to-html asciidoctor/docker-asciidoctor asciidoctor --base-dir /documents/ --backend html5 --failure-level WARN docs/fmi_specification.adoc + command: docker run -v ~/project/:/documents/ --name asciidoc-to-html asciidoctor/docker-asciidoctor asciidoctor --base-dir /documents/ --backend html5 --failure-level WARN docs/index.adoc - run: name: Validate HTML command: docker run -v ~/project/docs/:/documents/ 18fgsa/html-proofer /documents --only-4xx @@ -26,7 +26,7 @@ jobs: name: Create archive command: | cd ~/project - zip fmi-standard.zip README.adoc CHANGELOG.adoc LICENSE.txt docs/fmi_specification.html docs/fmi-spec.css docs/images/* headers/*.h schema/*.xsd + zip fmi-standard.zip README.adoc CHANGELOG.adoc LICENSE.txt docs/index.html docs/fmi-spec.css docs/images/* headers/*.h schema/*.xsd - store_artifacts: path: ~/project/fmi-standard.zip - run: @@ -39,7 +39,6 @@ jobs: git clone git@github.com:modelica/fmi-standard.org.git rsync -a --delete --exclude *.adoc ~/project/docs/ ~/fmi-standard.org/docs/3.0-dev/ cd fmi-standard.org - mv docs/3.0-dev/fmi_specification.html docs/3.0-dev/index.html git add docs/3.0-dev git commit -m "Update generated specification from fmi-standard (${CIRCLE_SHA1:0:7})" || echo "No changes to commit" git push diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 4efee36c1..634083ea7 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -31,7 +31,7 @@ where `` is the path to the cloned repository . Generate the HTML document + - asciidoctor -B /documents/ -b html5 docs/fmi_specification.adoc + asciidoctor -B /documents/ -b html5 docs/index.adoc `Alternative 2:` Ruby and the AsciiDoctor gem @@ -41,12 +41,12 @@ where `` is the path to the cloned repository . Generate the HTML document + - asciidoctor -B -b html5 docs/fmi_specification.adoc + asciidoctor -B -b html5 docs/index.adoc + where `` is the path to the cloned repository -The generated `docs/fmi_specification.html` can be viewed with any modern web browser. +The generated `docs/index.html` can be viewed with any modern web browser. == Using the issue tracker diff --git a/docs/fmi_specification.adoc b/docs/index.adoc similarity index 100% rename from docs/fmi_specification.adoc rename to docs/index.adoc