add some docs

2016-10-30 13:16:07 +02:00 · 2016-10-30 13:16:07 +02:00 · 5b4bf2a55a
parent ed345c258b
commit 5b4bf2a55a
17 changed files with 228 additions and 0 deletions
--- a/layers/+distributions/spacemacs-docker/README.org
+++ b/layers/+distributions/spacemacs-docker/README.org
@ -0,0 +1 @@
+WIP
--- a/layers/+distributions/spacemacs-docker/dockerfiles/examples/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/examples/README.org
@ -0,0 +1 @@
+WIP
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/README.org
@ -0,0 +1 @@
+WIP
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/README.org
@ -0,0 +1,18 @@
+#+TITLE: spacemacs-docker distribution installers 
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#subdirectories][Subdirectories]]
+ - [[#note][Note]]
+
+* Description
+This directory contains layers installation scripts and their dependencies
+ that will be executed by Dockerfiles.
+
+* Subdirectories
+1. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/README.org][deps-installers]]
+2. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/lib/README.org][lib]]
+
+* Note
+Dockerfiles actually use a copy of this directory
+located at =/usr/local/spacemacs=
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/README.org
@ -0,0 +1,29 @@
+#+TITLE: spacemacs-docker layers dependency installation scripts
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#supported-layers][Supported layers]]
+ - [[#how-it-works][How it works]]
+
+* Description
+Dependency installation scripts for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs/README.org][spacemacs-docker distribution.]]
+
+* Supported layers
+1. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/clojure/README.org][Clojure]]
+2. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/dash/README.org][Dash]]
+3. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/fasd/README.org][fasd]]
+4. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/go/README.org][Go]]
+5. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/gtags/README.org][gtags]]
+6. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/html/README.org][html]]
+7. [[https://github.com/syl20bnr/spacemacs/blob/master/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/javascript/README.org][JavaScript]]
+8. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/pandoc/README.org][pandoc]]
+9. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/pdf-tools/README.org][pdf-tools]]
+10. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/spell-checking/README.org][spell-checking]]
+
+* How it works
+[[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/Dockerfile][onbuild Dockerfile]] has [[https://docs.docker.com/engine/reference/builder/#/onbuild][ONBUILD instructions]] that copy users .spacemacs file, test and scan it.
+If the .spacemacs file contains one of supported layers and its installation
+isn't disabled, Docker builder will install the layers requirements (dependencies)
+taking into account layer's configuration. For example, it will install [[https://github.com/alecthomas/gometalinter][gometalinter]]
+only if =go-use-gometalinter= is =t=.
+*See* [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/lib/README.org][README.org of the spacemacs-docker libraries]] *for more details.*
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/clojure/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/clojure/README.org
@ -0,0 +1,16 @@
+#+TITLE: Clojure layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/clojure/README.org][Clojure layer.]]
+
+* List of installed software:
+1. [[http://packages.ubuntu.com/en/xenial/default-jre-headless][default-jre-headless]]
+2. [[https://leiningen.org/][Leiningen]]
+3. [[http://boot-clj.com/][Boot]]
+4. [[https://github.com/clojure-emacs/refactor-nrepl][refactor-nrepl]]
+5. [[https://github.com/cider/cider-nrepl][cider-nrepl]]
+6. [[https://github.com/weavejester/cljfmt][lein-cljfmt]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/dash/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/dash/README.org
@ -0,0 +1,25 @@
+#+TITLE: dash layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+ - [[#notes][Notes:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/dash/README.org][Dash layer.]]
+
+* List of installed software:
+1. [[http://packages.ubuntu.com/en/xenial/zeal][zeal]] - documentation browser.
+2. Docsets for layers (if the are used in .spacemacs):
+  a. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/clojure/README.org][clojure]]
+  b. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/go/README.org][go]]
+  c. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/html/README.org][html]]
+  d. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/emacs-lisp/README.org][emacs-lisp]]
+  e. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/javascript/README.org][javascript]]
+  f. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/docker/README.org][docker]]
+  g. [[https://github.com/syl20bnr/spacemacs/blob/b6d52030b165fc5b74c95d2ade9f1ba6b5c15ab7/layers/%2Blang/markdown/README.org][markdown]]
+
+* Notes:
+  - You can get more docsets at https://zealdocs.org
+  - Please open a PR/Issue if you want them added.
+  - Elisp docset has [[https://github.com/jinzhu/zeal-at-point/issues/28][an issue]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/fasd/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/fasd/README.org
@ -0,0 +1,11 @@
+#+TITLE: fasd layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/fasd/README.org][fasd layer.]]
+
+* List of installed software:
+1. [[https://github.com/clvv/fasd][fasd]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/go/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/go/README.org
@ -0,0 +1,19 @@
+#+TITLE: go layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/go/README.org][Go layer.]]
+
+* List of installed software:
+1. [[https://golang.org/][Go 1.7]]
+2. [[https://github.com/go-check/check/][go-check]]
+3. [[https://github.com/nsf/gocode][gocode]]
+4. [[https://github.com/rogpeppe/godef][godef]]
+5. [[https://godoc.org/golang.org/x/tools/cmd/guru][go-guru]]
+6. [[https://godoc.org/golang.org/x/tools/cmd/gorename][gorename]]
+7. [[https://godoc.org/golang.org/x/tools/cmd/goimports][goimports]]
+8. if ~go-use-gometalinter~ is ~t~:
+  a. [[https://github.com/alecthomas/gometalinter][gometalinter]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/gtags/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/gtags/README.org
@ -0,0 +1,13 @@
+#+TITLE: gtags layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btags/gtags/README.org][gtags layer.]]
+
+* List of installed software:
+1. [[http://packages.ubuntu.com/en/xenial/python-pygments][python-pygments]]
+2. [[https://github.com/universal-ctags/ctags][universal-ctags]]
+3. [[https://www.tamacom.com/global.html][global]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/html/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/html/README.org
@ -0,0 +1,21 @@
+#+TITLE: html layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Blang/html/README.org][html layer.]]
+
+* List of installed software:
+1. [[https://rubygems.org][rubygems]]
+2. [[https://www.npmjs.com][npm]]
+3. [[https://github.com/CSSLint/csslint][csslint]] 
+4. [[https://pugjs.org/api/getting-started.html][pug]] 
+5. [[https://github.com/pugjs/pug-cli][pug-cli]] 
+6. [[https://github.com/pugjs/pug-lint][pug-lint]] 
+7. [[http://slim-lang.com][slim]] 
+8. [[https://github.com/sds/slim-lint][slim_lint]] 
+9. [[http://sass-lang.com][sass]] 
+10. [[https://github.com/brigade/scss-lint][scss-lint]]
+11. [[https://github.com/Sweetchuck/scss_lint_reporter_checkstyle][scss_lint_reporter_checkstyle]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/javascript/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/javascript/README.org
@ -0,0 +1,17 @@
+#+TITLE: javascript layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/master/layers/%2Blang/javascript/README.org][JavaScript layer.]]
+
+* List of installed software:
+1. [[https://www.npmjs.com][npm]]
+2. [[https://github.com/CSSLint/csslint][csslint]]
+3. [[https://github.com/bernardmcmanus/httpd-node][httpd-node]]
+4. [[https://ternjs.net/][tern]]
+5. [[https://github.com/beautify-web/js-beautify][js-beautify]]
+6. [[https://github.com/eslint/eslint][eslint]]
+7. [[https://github.com/jshint/jshint][jshint]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/pandoc/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/pandoc/README.org
@ -0,0 +1,11 @@
+#+TITLE: pandoc layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/pandoc/README.org][pandoc layer.]]
+
+* List of installed software:
+1. [[http://packages.ubuntu.com/xenial/pandoc][pandoc]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/pdf-tools/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/pdf-tools/README.org
@ -0,0 +1,12 @@
+#+TITLE: pdf-tools layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/pdf-tools/README.org][pdf-tools layer.]]
+
+* List of installed software:
+1. [[https://www.imagemagick.org/script/index.php][imagemagick]]
+2. [[https://github.com/politza/pdf-tools][pdf-tools]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/spell-checking/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/spell-checking/README.org
@ -0,0 +1,11 @@
+#+TITLE: spell-checking layer dependency installation script
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#list-of-installed-software][List of installed software:]]
+
+* Description
+Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bcheckers/spell-checking/README.org][spell-checking  layer.]]
+
+* List of installed software:
+1. [[ispell][http://packages.ubuntu.com/xenial/ispell]]
--- a/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/lib/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/lib/README.org
@ -0,0 +1,21 @@
+#+TITLE: spacemacs-docker layers dependency installation libraries
+
+* Table of Contents                 :TOC_4_gh:noexport:
+ - [[#description][Description]]
+ - [[#library-list][library list]]
+ - [[#workflow][Workflow]]
+   - [[#how-to-write-scripts][How to write scripts]]
+   - [[#how-to-test-them][How to test them]]
+
+* Description
+Dependency installation libraries for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs/README.org][spacemacs-docker distribution.]]
+
+* library list
+1. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/lib/init.el][init.el]] - Installs packages used in the libs.
+2. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/lib/dockerfile-dsl.el][dockerfile-dsl.el]] - Elisp Dockerfile DSL (also used in =deps-dsl.el=).
+3. [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/lib/deps-dsl.el][deps-dsl.el]] - layers dependencies installation helpers.
+[[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+distributions/spacemacs-docker/dockerfiles/onbuild/usr/local/spacemacs/deps-installers/README.org][Usage examples.]]
+
+* Workflow
+** TODO How to write scripts
+** TODO How to test them
--- a/layers/+distributions/spacemacs-docker/dockerfiles/tools/README.org
+++ b/layers/+distributions/spacemacs-docker/dockerfiles/tools/README.org
@ -0,0 +1 @@
+WIP