README.adoc 4.29 KB
Newer Older
Emmanuel Milou's avatar
Emmanuel Milou committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
= SFL Boilerplate: a generic template for Drupal projects 
:keywords: Drupal, SFL, SFLinux, AsciiDoc, Asciidoctor 
:page-layout: base
:page-description: {description}
:page-keywords: {keywords}
ifdef::env-site[]
:toc:
:toc-placement: preamble
endif::[]
ifndef::env-site[]
:toc: right
:icons: font
:idprefix:
:idseparator: -
:sectanchors:
:source-highlighter: highlight.js
endif::[]
:experimental:
:mdash: —
:language: asciidoc
:source-language: {language}
:table-caption!:
:example-caption!:
:figure-caption!:
:imagesdir: ../images
:includedir: _includes
// Refs
:asciidoc-dl-ref: http://sourceforge.net/projects/asciidoc/files/latest/download
:asciidoc-editor-ref: http://asciidoc.org/#_editor_support
:asciidoc-faq-ref: http://asciidoc.org/faq.html
:asciidoc-guide-ref: http://asciidoc.org/userguide.html
:asciidoc-install-ref: http://asciidoc.org/INSTALL.html
:asciidoc-list-ref: http://groups.google.com/group/asciidoc
:asciidoctor-ref: http://asciidoctor.org/
:asciidoctor-gem-ref: https://rubygems.org/gems/asciidoctor
:uri-install: http://asciidoctor.org/docs/install-toolchain/
:fopub-doc-ref: https://github.com/asciidoctor/asciidoctor-fopub/blob/master/README.adoc
:user-ref: http://asciidoctor.org/docs/user-manual
:docs-ref: http://asciidoctor.org/docs
:uri-editing: http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/
:gist-ref: http://gist.github.com
:publican-ref: https://fedorahosted.org/publican
:sfl-wiki-drupal: https://wiki.savoirfairelinux.com/wiki/Pratique_Drupal
:doc-docker: https://www.docker.com/
:doc-fabric: http://www.fabfile.org/
:doc-docker-installation: https://docs.docker.com/engine/installation/
:doc-docker-baseimage: https://gitlab.savoirfairelinux.com/drupal/docker-lampd/
:uri-what-asciidoc: http://asciidoctor.org/docs/what-is-asciidoc-why-use-it


    / __/ __/ /  /  _/ |/ / / / / |/_/
   _\ \/ _// /___/ //    / /_/ />  <  
  /___/_/ /____/___/_/|_/\____/_/|_|  


// (to make a title: echo " CLIENT.PROJECT" | figlet -f smslant )

This *generic template* aims at _implementating_ a default project tree, that then could be used as a *starter kit* for new Drupal projects. 

TIP: More information on our Drupal practices at Savoir-faire Linux are described in {sfl-wiki-drupal}[the official Wiki].


== System Requirements

This installation profile has been designed to work with Drupal 7, and is compatible with PHP > 5.3.
Ensure your system is properly installed.

TIP: Whenever it is possible, you should use *Composer* to install and manage the PHP dependencies.

The following dependencies need to be installed:

* {doc-docker}[Docker]
* {doc-docker-baseimage}[Docker base image]
* {doc-fabric}[Fabric]
* Drush (version 6 or version 7)

== Installation

CAUTION: The installation procedure to set-up Docker is not described here. Please refer to the official documentation on how to install {doc-docker-installation}[Docker Engine]. The {doc-docker-baseimage}[Docker base image] should also be installed at this point.

First, you should clone this repository. 

 $ git clone --recursive https://gitlab.savoirfairelinux.com/drupal/sfl-boilerplate.git

It is recommanded to clone with the _recursive_ option to automatically fetch the included _git submodules_.

Then, copy and, optionally, edit your local configuration file:

 $ cp deploy/local_vars.py drupalizer/local_vars.py

You are now ready to build the SFLinux distribution:

 $ cd drupalizer
 $ fab local_setup

The Docker image containing the Drupal installation should now be up and running, and the site should now be accessible at http://local.boilerplate.sfl.

== Official documentation

More on Drupal distributions: https://www.drupal.org/documentation/build/distributions.

More on Drush and Makefile: https://www.drupal.org/node/1432374.

== About this document

This document uses the Asciidoc syntax generator. It is a convenient
tool allowing to write documentation in raw text files, and convert
them to HTML or PDF later on.

To generate a HTML version, first install asciidoctor package on your
Linux distribution, then issue following command:

 $ asciidoctor README.adoc

The README.html is generated in the current directory.

If you prefer the PDF format, install dblatex package on your Linux
distribution, then issue following command:

 $ a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" README.adoc

The README.pdf file shall be created.