fluo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [fluo-website] branch gh-pages updated: Two minor updates to future Fluo 1.2.0 docs (#89)
Date Mon, 25 Sep 2017 21:09:13 GMT
This is an automated email from the ASF dual-hosted git repository.

mwalch pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/fluo-website.git


The following commit(s) were added to refs/heads/gh-pages by this push:
     new c200593  Two minor updates to future Fluo 1.2.0 docs (#89)
c200593 is described below

commit c200593b5e2a99c93db7cdf5c75032578ec959fa
Author: Mike Walch <mwalch@apache.org>
AuthorDate: Mon Sep 25 17:09:11 2017 -0400

    Two minor updates to future Fluo 1.2.0 docs (#89)
    
    * Started using variable for Fluo version
    * Remove old docs conversion script
---
 _fluo-docs-1-2/development/applications.md |   4 +-
 _fluo-docs-1-2/getting-started/install.md  |   6 +-
 _scripts/convert-fluo-docs.py              | 103 -----------------------------
 3 files changed, 5 insertions(+), 108 deletions(-)

diff --git a/_fluo-docs-1-2/development/applications.md b/_fluo-docs-1-2/development/applications.md
index a1fb8f9..4f554f7 100644
--- a/_fluo-docs-1-2/development/applications.md
+++ b/_fluo-docs-1-2/development/applications.md
@@ -20,12 +20,12 @@ For both clients and observers, you will need to include the following
in your M
 <dependency>
   <groupId>org.apache.fluo</groupId>
   <artifactId>fluo-api</artifactId>
-  <version>1.2.0</version>
+  <version>{{ page.version }}</version>
 </dependency>
 <dependency>
   <groupId>org.apache.fluo</groupId>
   <artifactId>fluo-core</artifactId>
-  <version>1.2.0</version>
+  <version>{{ page.version }}</version>
   <scope>runtime</scope>
 </dependency>
 ```
diff --git a/_fluo-docs-1-2/getting-started/install.md b/_fluo-docs-1-2/getting-started/install.md
index 68de78b..c38441a 100644
--- a/_fluo-docs-1-2/getting-started/install.md
+++ b/_fluo-docs-1-2/getting-started/install.md
@@ -36,8 +36,8 @@ After you obtain a Fluo distribution tarball, follow these steps to install
Fluo
 
 1.  Choose a directory with plenty of space and untar the distribution:
 
-        tar -xvzf fluo-1.2.0-bin.tar.gz
-        cd fluo-1.2.0
+        tar -xvzf fluo-{{ page.version }}-bin.tar.gz
+        cd fluo-{{ page.version }}
 
     The distribution contains a `fluo` script in `bin/` that administers Fluo and the
     following configuration files in `conf/`:
@@ -77,7 +77,7 @@ invoked by this script.
 Modify and add the following to your `~/.bashrc` if you want to be able to execute the fluo
script
 from any directory:
 
-    export PATH=/path/to/fluo-1.2.0/bin:$PATH
+    export PATH=/path/to/fluo-{{ page.version }}/bin:$PATH
 
 Source your `.bashrc` for the changes to take effect and test the script
 
diff --git a/_scripts/convert-fluo-docs.py b/_scripts/convert-fluo-docs.py
deleted file mode 100755
index 8e593ac..0000000
--- a/_scripts/convert-fluo-docs.py
+++ /dev/null
@@ -1,103 +0,0 @@
-#!/usr/bin/python
-
-import sys
-from os import listdir, makedirs
-from os.path import isfile, join, exists
-import shutil
-
-if len(sys.argv) != 3:
-  print "Usage: ./convert-docs.py <inputDocsDir> <outputDocsDir>"
-  sys.exit(-1)
-
-input_dir = sys.argv[1]
-output_dir = sys.argv[2]
-
-args = output_dir.rpartition("/docs")
-url_prefix = args[1] + args[2]
-release_ver = url_prefix.split("/")[3]
-github_prefix = "https://github.com/apache/fluo/blob/rel/fluo-{0}/modules/".format(release_ver)
-javadocs_prefix = "{{ site.fluo_api_static }}/" + release_ver + "/"
-resources_prefix = "/docs/fluo/{0}/resources/".format(release_ver)
-
-def path_to_url(path):
-  if path.find("#") != -1:
-    print "WARNING - URL references anchor tag #: ", path.strip()
-  url = url_prefix + path.rpartition("/")[2].replace(".md", "/")
-  if url.endswith("/index/"):
-    return url.replace("/index/", "/")
-  return url
-
-def convert_file(inPath, outPath):
-
-  print "Creating ", outPath
-
-  with open(inPath) as fin:
-
-    # skip license
-    line = ''
-    while not line.startswith('-->'):
-      line = fin.readline().strip()
-
-    # read title
-    title = ''
-    while len(title) == 0:
-      title = fin.readline().strip()
-    title = title.lstrip(' #').strip()
-
-    fin.readline()
-
-    if inPath.endswith("README.md"):
-      title = "Fluo {0} Documentation".format(release_ver)
-
-    with open(outPath, "w") as fout:
-      print >> fout, "---" 
-      print >> fout, "layout: fluo-doc" 
-      print >> fout, "title: ", title 
-      print >> fout, "version: ", release_ver
-      print >> fout, "---"
-
-      if inPath.endswith("README.md"):
-        fin.readline()
-        fin.readline()
-
-      for line in fin:
-        if line.startswith("["):
-          if line.find(".md") != -1:
-            for word in line.split(' '):
-              if word.find(".md") != -1:
-                fout.write(path_to_url(word))
-              else:
-                fout.write(word+" ")
-          elif line.find("../modules") != -1:
-            if line.strip().endswith(".java"):
-              start = line.find("../modules/")
-              end = line.find("org/apache/fluo")
-              fout.write(line.replace(line[start:end], javadocs_prefix).replace(".java",
".html"))
-            else:
-              fout.write(line.replace("../modules/", github_prefix))
-          elif line.find("resources/") and any(x in line for x in ('.png','.jpg','.pdf')):
-            fout.write(line.replace("resources/", resources_prefix))
-          else:
-            fout.write(line)
-        else:
-          fout.write(line)
-
-convert_file(join(input_dir,"../README.md"), join(output_dir, "index.md"))
-
-for f in listdir(input_dir):
-  fn = join(input_dir, f)
-  if isfile(fn) and fn.endswith(".md"):
-    convert_file(fn, join(output_dir, f))
-
-src_resources = join(input_dir, 'resources')
-dst_resources = join(output_dir, 'resources')
-
-if not exists(dst_resources):
-  makedirs(dst_resources)
-
-for f in listdir(src_resources):
-  src = join(src_resources, f)
-  dst = join(dst_resources, f)
-
-  if not exists(dst) and isfile(src) and src.endswith(('.png','.jpg','.pdf')):
-    shutil.copy(src, dst_resources)

-- 
To stop receiving notification emails like this one, please contact
['"commits@fluo.apache.org" <commits@fluo.apache.org>'].

Mime
View raw message