CELIX-449: Refactors how the menu works. Now uses Hugo's section concept
authorPepijn Noltes <pepijnnoltes@gmail.com>
Wed, 4 Jul 2018 19:08:40 +0000 (21:08 +0200)
committerPepijn Noltes <pepijnnoltes@gmail.com>
Wed, 4 Jul 2018 19:08:40 +0000 (21:08 +0200)
README.md
content/community/about.md [moved from content/community/index.md with 99% similarity]
content/downloads/download.md [moved from content/downloads/index.md with 99% similarity]
content/support/_index.md [deleted file]
content/support/issuetracking.md
content/support/mailinglist.md
copy_docs_from_src_to_content.sh
themes/celix/layouts/partials/top_level_menu.html

index 8def5f0..130812c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,14 +26,22 @@ This is the website for [Apache Celix](https://celix.apache.org/), hosted at:
 
 The Celix website uses the Hugo content management system. See [Hugo](https://gohugo.io) for more info and for details how to install hugo
 
-## Run the website locally
+## Generate the website
 
-On the root dir, run: `hugo server -D`. The -D is provided to also host draft pages.
+### Copy documentation dir from celix repo
 
-## Generate the status website
+ - Run `git submodule init` and `git submodule update` to retreive the Celix sources
+ - Run `./copy_docs_from_src_to_content.sh` to copy the documents director to the website content documentation section 
+
+### Create doxygen documentation
+
+TODO
+
+### Generate the static website
 
 To generate the static website run: `hugo`. The resulting public dir should contain a updated static website.
+Or to just host it locally run: `hugo server -D`. The -D is provided to also host draft pages.
 
-## Initialize celix git submodule
+## Publish the website
 
 TODO
similarity index 99%
rename from content/community/index.md
rename to content/community/about.md
index 8d17839..6f63e39 100644 (file)
@@ -16,7 +16,6 @@
 # specific language governing permissions and limitations
 # under the License.
 title: Community
-menu: main
 ---
 # Celix Community
 
similarity index 99%
rename from content/downloads/index.md
rename to content/downloads/download.md
index 15f971e..754d929 100755 (executable)
@@ -16,7 +16,6 @@
 # specific language governing permissions and limitations
 # under the License.
 title: Download
-menu: main
 ---
 # Download Celix
 
diff --git a/content/support/_index.md b/content/support/_index.md
deleted file mode 100644 (file)
index c6bf84b..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
----
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
-# to you 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.
-title: "Support"
-menu: 
-  main:
-    identifier: "support"
----
index 1b2dfd6..b6dd52d 100644 (file)
@@ -16,9 +16,6 @@
 # specific language governing permissions and limitations
 # under the License.
 title: "Issues"
-menu:
-  main:
-    parent: "support"
 ---
 # Issue Tracking
 
index 45a204c..7ad7d0f 100644 (file)
@@ -16,9 +16,6 @@
 # specific language governing permissions and limitations
 # under the License.
 title: "Mailing list"
-menu:
-  main:
-    parent: "support"
 ---
 # Mailing List
 
index 22ce919..9e22924 100755 (executable)
@@ -1,11 +1,12 @@
 #!/bin/sh
 
 src_doc_dir=celix-src/documents
-site_doc_dir=content/documents
+site_doc_dir=content/documentation
 
 for file in `cd ${src_doc_dir}; find . -name \*.md`
 do
-    dest=`dirname ${file}`
-    mkdir -p ${site_doc_dir}/${dest}
-    cp -v ${src_doc_dir}/${file} ${site_doc_dir}/${dest}/index.md
+    dest="`dirname ${file}`.md"
+    dest_dir="`dirname ${dest}`"
+    mkdir -p ${site_doc_dir}/${dest_dir}
+    cp -v ${src_doc_dir}/${file} ${site_doc_dir}/${dest}
 done
index e7042ea..f428806 100644 (file)
@@ -20,18 +20,13 @@ limitations under the License.
        <select class="mobbutton" onchange="if (this.value) window.location.href=this.value">
                <option value="">navigate</option>
         <option value="/">Home</option>
-               <option value="/doc/">Documentation</option>
-        {{ range .Site.Menus.main }}
-            {{ if .HasChildren }}
+        {{ range .Sections }}
                 <optgroup label="{{ .Name }}">
                     <option value="{{ .URL }}">{{ .Name }}</option>
-                {{ range .Children }}
+                {{ range .Pages }}
                     <option value="{{ .URL }}">{{ .Name }}</option>
                 {{ end }}
                 </optgroup>
-            {{ else }}
-                <option value="{{ .URL }}">{{ .Name }}</option>
-            {{ end }}
         {{ end }}
         <!--
                <option value="/downloads/">Downloads</option>
@@ -56,20 +51,16 @@ limitations under the License.
        </select>
        <div id="dropmenu" class="shadowed">
                <a href="/"><div class="dropbutton">Home</div></a>
-        <a href="/doc/"><div class="dropbutton">Documentation</div></a>
-        {{ range .Site.Menus.main }}
-            {{ if .HasChildren }}
-                <div class="dropdown">
-                    <div class="dropbutton">{{ .Name }}<div class="triangle"></div></div>
-                    <div class="dropdown-content">
-                    {{ range .Children }}
-                        <a href="{{ .URL }}">{{ .Name }}</a>
-                    {{ end }}
-                    </div>
+
+        {{ range .Site.Sections }}
+            <div class="dropdown">
+                <div class="dropbutton">{{ .Name }}<div class="triangle"></div></div>
+                <div class="dropdown-content">
+                {{ range .Pages }}
+                    <a href="{{ .URL }}">{{.Title}}</a>
+                {{ end }}
                 </div>
-           {{ else }}  
-               <a href="{{ .URL }}"><div class="dropbutton">{{ .Name }}</div></a>
-           {{ end }}
+            </div>
         {{ end }}
         
         <div class="dropdown">