README 3.65 KB
Newer Older
1
= Boilerplate template for Drupal projects 
Emmanuel Milou's avatar
Emmanuel Milou committed
2
3
SFL Drupal Team <drupal@lists.savoirfairelinux.net>
v2.0, 2016-03-10
Emmanuel Milou's avatar
Emmanuel Milou committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
: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:
Emmanuel Milou's avatar
Emmanuel Milou committed
18
:source-highlighter: highlightjs
Emmanuel Milou's avatar
Emmanuel Milou committed
19
20
21
22
23
24
25
26
27
28
29
endif::[]
:experimental:
:mdash: &#8212;
:language: asciidoc
:source-language: {language}
// Refs
: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/
30
:gitlab-sflinux: https://gitlab.savoirfairelinux.com/drupal/sflinux
Emmanuel Milou's avatar
Emmanuel Milou committed
31

Emmanuel Milou's avatar
Emmanuel Milou committed
32
33
34
35
   __________   _____  ____  ___  __  ____   
  / __/ __/ /  /  _/ |/ / / / / |/_/ /_  /__ __
 _\ \/ _// /___/ //    / /_/ />  <    / / \ \ /
/___/_/ /____/___/_/|_/\____/_/|_|   /_(_)_\_\ 
Emmanuel Milou's avatar
Emmanuel Milou committed
36
37
38
39
40


// (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. 
41
It uses our custom Drupal distribution {gitlab-sflinux}[*SFLinux*] as codebase.
Emmanuel Milou's avatar
Emmanuel Milou committed
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

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:

Emmanuel Milou's avatar
Emmanuel Milou committed
71
 $ cp conf/local_vars.py drupalizer/local_vars.py
Emmanuel Milou's avatar
Emmanuel Milou committed
72
73
74
75
76
77
78
79

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.

Emmanuel Milou's avatar
Emmanuel Milou committed
80
include::drupalizer/README[]
81

Emmanuel Milou's avatar
Emmanuel Milou committed
82
83
84
85
86
87
88
89
90
91
92
93
== 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.

Emmanuel Milou's avatar
Emmanuel Milou committed
94
95
Visit https://github.com/asciidoctor[Asciidoctor @ *GitHub*] for more informations.

Emmanuel Milou's avatar
Emmanuel Milou committed
96
97
98
To generate a HTML version, first install asciidoctor package on your
Linux distribution, then issue following command:

Emmanuel Milou's avatar
Emmanuel Milou committed
99
 $ asciidoctor README
Emmanuel Milou's avatar
Emmanuel Milou committed
100
101
102
103
104
105

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:

Emmanuel Milou's avatar
Emmanuel Milou committed
106
 $ a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" README
Emmanuel Milou's avatar
Emmanuel Milou committed
107
108

The README.pdf file shall be created.
Emmanuel Milou's avatar
Emmanuel Milou committed
109