Merge branch 'release/0.18.0' into stable

azukiapp · Apr 7, 2016 · 109e8ac · 109e8ac
2 parents afd0da9 + 9f100be
commit 109e8ac
Show file tree

Hide file tree

Showing 107 changed files with 1,914 additions and 729 deletions.
diff --git a/CONTRIBUTING.md → .github/CONTRIBUTING.md b/CONTRIBUTING.md → .github/CONTRIBUTING.md
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,37 @@
+---- Instructions: please remove it before posting ----
+
+Hi. We've set up a few optional questions to help you to structure your issue.
+It would also help us to assist you more quickly and efficiently.
+
+We strongly recommend you to write your message in English for 2 main reasons:
+
+1. Your issue can also be others' problems;
+2. Makes it easier for our community users to help each others out.
+
+---------------------------------------------------------
+
+1. What are you trying do accomplish?
+
+[Describe in a few words what you are trying to do]
+
+2. Steps to reproduce the described behavior
+
+[Give us enough data to reproduce this scenario]
+
+3. Output
+
+```
+[The error message you are facing]
+```
+
+4. Further info
+
+a. Which OS / distro?
+b. Uses VirtualBox? Which version?
+c. Can you provide us your Azkfile.js?
+
+**ProTip**: run `azk version --full` to gather those info.
+
+5. Do you have any suggestions on how to tackle this?
+
+[Optional]
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,40 @@
+---- Instructions: please remove it before posting ----
+
+Hi. We've set up a few optional questions to help you to structure your PR.
+It would also help us to assist you more quickly and efficiently.
+
+We strongly recommend you to write your message in English for 2 main reasons:
+
+1. Your improvement can fit others' needs;
+2. Makes it easier for our community users to help each others out;
+
+There are two types of templates you can use:
+---------------------------------------------------------
+
+A. If it's a work in progress
+
+1. What is this PR objective?
+
+[What is this solving?]
+
+2. Tasklist
+
+- [ ] Task one
+- [ ] Task two
+- [ ] ...
+
+---------------------------------------------------------
+
+B. If it's a finished PR
+
+1. What is this PR objective?
+
+[What is this solving or implementing?]
+
+2. How did you tackle the issue?
+
+[Write in details your decisions/perceptions and how you accomplished this]
+
+3. How to test it?
+
+[How can we test?]
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@
 /node_modules
 /build
 npm-debug.log
+.package-envs
diff --git a/Azkfile.js b/Azkfile.js
@@ -3,9 +3,11 @@
  */
 
 var mounts = {
-  "/azk/#{manifest.dir}": sync('./', { shell: true }),
-  "/azk/#{manifest.dir}/package": path("./package"),
-  "/azk/#{manifest.dir}/node_modules": persistent('node_modules-#{system.name}'),
+  "/azk/#{manifest.dir}" :         sync('./', { shell: true }),
+  "/azk/#{manifest.dir}/package" : path("./package"),
+  "/azk/#{manifest.dir}/docs" :    path("./docs"),
+  "/azk/#{manifest.dir}/node_modules" :  persistent('node_modules-#{system.name}'),
+  "/azk/#{manifest.dir}/.package-envs" : path("./.package-envs"),
   "/azk/demos"          : path("../demos"),
   "/azk/build"          : persistent('build-#{system.name}'),
   "/azk/lib"            : persistent('lib-#{system.name}'),

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## v0.18.0 - (2016-04-07)
+
+* Enhancements
+  * [Code] Adding github issue and PR templates;
+  * [Docs] The instructions for use `azk` and `Wordpress` have been improved;
+  * [Manifest] Adding `resolve` options to `path`, with default `true` value;
+  * [Docs] Updating whole docs structure: Azkfile, Gitbook version and plugins;
+  * [Cli] `azk version` changes to display the first 7 digits of the commit hash and the date of the corresponding commit version;
+  * [Cli] Adding options `--full` and `--logo` the command `azk version`, to show more information (old `azk doctor`);
+  * [Cli] Adding more options to `azk info`, now have a `--filter` and `--json`;
+
+* Deprecations
+  * [Cli]  Deprecating `azk doctor` command, now use `azk version --full`;
+  * [Manifest] Deprecating template expander tokens `${}` and  `<%%>`;
+
+* Bug
+  * [Sync] Fixing ownership of the symlink itself, not of the target file;
+  * [Cli] Enabling back deprecation warnings;
+
 ## v0.17.0 - (2016-02-19)
 
 * Enhancements

diff --git a/Makefile b/Makefile
@@ -160,13 +160,13 @@ package_clean:
 	@echo "task: $@"
 	@rm -Rf ${AZK_PACKAGE_PREFIX}/..?* ${AZK_PACKAGE_PREFIX}/.[!.]* ${AZK_PACKAGE_PREFIX}/*
 
-check_version: NEW_AZK_VERSION=$(shell ${PATH_USR_LIB_AZK}/bin/azk version)
+check_version: NEW_AZK_VERSION=$(shell ${PATH_USR_LIB_AZK}/bin/azk version | sed -e 's/^azk //; s/^version //; s/,.*//' )
 check_version:
 	@echo "task: $@"
-	@if [ ! "azk ${AZK_VERSION}" = "${NEW_AZK_VERSION}" ] ; then \
+	@if [ ! "${AZK_VERSION}" = "${NEW_AZK_VERSION}" ] ; then \
 		echo 'Error to run: ${PATH_USR_LIB_AZK}/bin/azk version'; \
 		echo 'Expect: azk ${AZK_VERSION}'; \
-		echo 'Output: ${NEW_AZK_VERSION}'; \
+		echo 'Output: azk ${NEW_AZK_VERSION}'; \
 		exit 1; \
 	fi
 
@@ -208,7 +208,7 @@ $(abspath $(2)/$(3)): $(abspath $(1)/$(3))
 endef
 
 # copy regular files
-FILES_FILTER  = package.json bin shared .nvmrc CHANGELOG.md LICENSE README.md .dependencies
+FILES_FILTER  = package.json bin shared .nvmrc CHANGELOG.md LICENSE README.md .dependencies .package-envs
 FILES_ALL     = $(shell cd ${AZK_ROOT_PATH} && find $(FILES_FILTER) -print 2>/dev/null | grep -v shared/completions)
 FILES_TARGETS = $(foreach file,$(addprefix $(PATH_USR_LIB_AZK)/, $(FILES_ALL)),$(abspath $(file)))
 $(foreach file,$(FILES_ALL),$(eval $(call COPY_FILES,$(AZK_ROOT_PATH),$(PATH_USR_LIB_AZK),$(file))))

diff --git a/README.md b/README.md
@@ -126,7 +126,7 @@ Share the love and star us here in Github!
 
 ## License
 
-"Azuki", "azk" and the Azuki logo are copyright (c) 2013-2015 Azuki Serviços de Internet LTDA.
+"Azuki", "azk" and the Azuki logo are copyright (c) 2013-2016 Azuki Serviços de Internet LTDA.
 
 **azk** source code is released under Apache 2 License.
 

diff --git a/bin/azk b/bin/azk
@@ -49,6 +49,9 @@ export PATH=$AZK_NPM_PATH/.bin:$PATH
 
 # Load dependencies versions
 . ${AZK_ROOT_PATH}/.dependencies
+if [ -e ${AZK_ROOT_PATH}/.package-envs ]; then
+  . ${AZK_ROOT_PATH}/.package-envs
+fi
 export AZK_DOCKER_MIN_VERSION=${AZK_DOCKER_MIN_VERSION}
 export AZK_DOCKER_API_VERSION=${AZK_DOCKER_API_VERSION}
 export AZK_ISO_VERSION=${AZK_ISO_VERSION}

diff --git a/docs/.env.sample b/docs/.env.sample
@@ -2,5 +2,6 @@ AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXX
 AWS_SECRET_KEY=XXXXXXXXXXXXXXXXX
 AWS_BUCKET_PROD=[bucket to prod deploy]
 AWS_BUCKET_STAGE=[bucket to stage deploy]
-GA_UA=UA-XXXXXXXX-X
-GA_COOKIE_DOMAIN=azk.io
+UA_CODE=UA-XXXXXXXX-X
+GA_LEGACY_COOKIE_DOMAIN=azk.io
+HOTJAR_ID=XXXXXXX
diff --git a/docs/Azkfile.js b/docs/Azkfile.js
@@ -10,28 +10,35 @@ systems({
     // Steps to execute before running instances
     provision: [
       "npm i",
-      "node node_modules/.bin/gitbook install content",
+      "gitbook install content",
     ],
     workdir: "/azk/#{manifest.dir}",
     shell: "/bin/bash",
-    command: "node_modules/.bin/gitbook serve --port $HTTP_PORT content",
-    wait: {"retry": 20, "timeout": 2000},
+    command: "gitbook serve --port $HTTP_PORT content --lrport $LIVERELOAD_PORT",
+    wait: 20,
     mounts: {
-      '/azk/#{manifest.dir}': path("."),
-      '/azk/CONTRIBUTING.md': path("../CONTRIBUTING.md"),
-      '/azk/node_modules': persistent("node_modules"),
+      '/azk/#{manifest.dir}'         : sync(".", {shell: true}),
+      '/azk/.github/CONTRIBUTING.md' : path("../.github/CONTRIBUTING.md"),
+      '/azk/package.json'            : path("./package.json"),
+      '/azk/#{manifest.dir}/content/pt-BR/styles' : sync("./content/common/styles", {shell: true}),
+      '/azk/#{manifest.dir}/content/en/styles'    : sync("./content/common/styles", {shell: true}),
+      '/azk/#{manifest.dir}/node_modules'         : persistent("node_modules"),
+      '/azk/#{manifest.dir}/content/_book'        : persistent("book"),
+      '/azk/#{manifest.dir}/content/node_modules' : persistent("content/node_modules"),
+      '/root/.npm'     : persistent("npm-cache"),
+      '/root/.gitbook' : persistent("gitbook-versions"),
     },
     scalable: {"default": 1},
     http: {
       // docs-azk.
       domains: [ "#{system.name}.#{azk.default_domain}" ]
     },
+    envs: {
+      PATH: "/azk/#{manifest.dir}/node_modules/.bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+    },
     ports: {
       http:       "5000/tcp",
-      livereload: "35729:35729/tcp",
+      livereload: "35730:35730/tcp",
     },
   },
 });
-
-
-
diff --git a/docs/README.md b/docs/README.md
@@ -1,39 +1,27 @@
 # azk documentation
 
-This documentation is made using Gitbook.
+`azk` documentation was built upon Gitbook.
 
-To start contributing:
-
-### Prepare your environment
-
-```sh
-azk nvm npm install
-azk nvm gitbook install content
-azk nvm gitbook build   content
-```
-
-### Start server
+### Starting Gitbook server with azk
 
 ```sh
-# if you have node and gitbook installed
-gitbook serve content
-
-# this will work if you have azk instaled
-azk nvm gitbook serve content
+azk start -o && azk logs --follow
 ```
 
-Now you can open [http://localhost:4000](http://localhost:4000). :)
+After a few minutes, `azk` docs will be up and running on [docs-azk.dev.azk.io](docs-azk.dev.azk.io). :)
 
 ## Deploying
 
-Before deploying you must create a file named `.env` or copy and update `.env.sample`
+Before deploying you must create a file called `.env` or copy and update `.env.sample`
 
 ```ini
 AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXX
 AWS_SECRET_KEY=XXXXXXXXXXXXXXXXX
 AWS_BUCKET_PROD=[bucket to prod deploy]
 AWS_BUCKET_STAGE=[bucket to stage deploy]
-MIXPANEL_TOKEN=XXXXXXXXXXXXXXXXX
+UA_CODE=UA-XXXXXXXX-X
+GA_LEGACY_COOKIE_DOMAIN=azk.io
+HOTJAR_ID=XXXXXXX
 ```
 
 ### azk buckets
@@ -49,8 +37,8 @@ docs.azk.io
 ### Build and deploy
 
 ```sh
-azk nvm gulp deploy-stage
-azk nvm gulp deploy-prod
+azk shell -- gulp deploy --stage
+azk shell -- gulp deploy --prod
 ```
 
 #### [! danger !] to remove all files from a bucket use s3cmd

diff --git a/docs/content/.htpasswd b/docs/content/.htpasswd
diff --git a/docs/content/README.md b/docs/content/README.md
diff --git a/docs/content/book.json b/docs/content/book.json
@@ -1,21 +1,43 @@
 {
   "title": "azk Docs Gitbook",
   "description": "Gitbook documentation for azk",
-  "version": "1.0.0",
+  "version": "2.6.4",
   "azkVersion": "0.13.0",
-  "releaseNotes": "http://......",
+  "releaseNotes": "https://github.com/azukiapp/azk/blob/master/CHANGELOG.md",
   "plugins": [
-      "scrollablecode",
-      "[email protected]",
-      "include",
-      "[email protected]"
+    "ga",
+    "hotjar",
+    "include",
+    "scrollablecode",
+    "-sharing",
+    "github",
+    "sitemap",
+    "anchors"
   ],
   "pluginsConfig": {
+    "hotjar": {
+      "hjid": 12345678901
+    },
     "ga": {
       "token": "GA_UA_ID",
       "configuration": {
-        "cookieDomain": "GA_COOKIE_DOMAIN"
+        "legacyCookieDomain": "GA_LEGACY_COOKIE_DOMAIN"
       }
+    },
+    "sharing": {
+      "facebook": true,
+      "twitter": true,
+      "google": false,
+      "weibo": false,
+      "instapaper": false,
+      "vk": false,
+      "all": []
+    },
+    "github": {
+      "url": "https://github.com/azukiapp/azk"
+    },
+    "sitemap": {
+      "hostname": "http://docs.azk.io/"
     }
   },
   "links": {
@@ -24,12 +46,6 @@
     "theme": "node_modules/gitbook-theme-clarity/lib",
     "custom": {
         "custom": "http://azukiapp.com"
-    },
-    "sharing": {
-      "google": false,
-      "facebook": null,
-      "twitter": null,
-      "all": false
     }
   }
 }