Browse Source

HUE-8741 [doc] Add instruction on how to build the new website

Romain Rigaux 6 years ago
parent
commit
f45df0be6e

+ 1 - 1
docs/docs-site/config.toml

@@ -14,7 +14,7 @@ home = [ "HTML", "RSS", "JSON"]
   # Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page. 
   # Useful to give opportunity to people to create merge request for your doc.
   # See the config.toml file from this documentation site to have an example.
-  editURL = "https://github.com/cloudera/hue/blob/master/docs/docs-site/"
+  editURL = "https://github.com/cloudera/hue/blob/master/docs/docs-site/content/"
   # Author of the site, will be used in meta information
   author = ""
   # Description of the site, will be used in meta information

+ 24 - 1
docs/docs-site/content/developer/development/_index.md

@@ -487,7 +487,30 @@ JavaScript.
 
 ### Documentation
 
-Building with
+New website:
+
+* Install https://gohugo.io/getting-started/quick-start/
+* Make sure the base URL is correct:
+
+    cd docs/docs-site
+    vim config.toml
+    baseURL='http://cloudera.github.io/hue/docs-4.4.0/'
+
+* Build the doc website: 
+
+    hugo server -wDs . -d ~/tmp/docs-4.4.0
+
+* Add it to the github page and push:
+
+    git checkout gh-pages
+    cp ~/tmp/docs-4.4.0 .
+    rm latest
+    ln -s docs-4.4.0 latest
+
+    git push origin HEAD:gh-pages
+
+
+Old documentation:
 
     make docs
 

+ 1 - 1
docs/docs-site/layouts/partials/favicon.html

@@ -1,2 +1,2 @@
-<link rel="shortcut icon" href="/images/favicon.ico" type="image/x-icon" />
+<link rel="shortcut icon" href="/hue/images/favicon.ico" type="image/x-icon" />
 

+ 1 - 1
docs/docs-site/layouts/partials/logo.html

@@ -1 +1 @@
-<img src="/hue/docs-4.4.0/images/hue_logo.png" alt="alt text" title="Hue Logo">
+<img src="/hue/images/hue_logo.png" alt="alt text" title="Hue Logo">