README.adoc 4.13 KB
Newer Older
1
= SFLinux Drupal Boilerplate
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
SFL Drupal Team <drupal@lists.savoirfairelinux.net>
v2.0, 2016-03-10
: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: highlightjs
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/
29
:doc-docker-baseimage: https://hub.docker.com/r/savoirfairelinux/lampd/
30
31
:doc-drush: http://docs.drush.org/en/master/
:gitlab-sflinux: https://gitlab.savoirfairelinux.com/drupal/sflinux
32
:doc-asciidoctor: http://asciidoctor.org/docs/asciidoc-recommended-practices/
33
34

image::http://test.savoirfairelinux.com/buildStatus/icon?job=drupal-sfl-boilerplate[Build status]
35

36
37
38
39
40
41
42
43
44
   __________   _____  ____  ___  __  ____
  / __/ __/ /  /  _/ |/ / / / / |/_/ /_  /__ __
 _\ \/ _// /___/ //    / /_/ />  <    / / \ \ /
/___/_/ /____/___/_/|_/\____/_/|_|   /_(_)_\_\


// (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.
45

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
It uses our custom Drupal distribution {gitlab-sflinux}[*SFLinux*] as codebase.

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-fabric}[Fabric]
* {doc-drush}[Drush] (version 6 or 7)

== Installation

65
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 Docker image is based on our {doc-docker-baseimage}[Docker base image], that will automatically installed at setup.
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

First, you should clone this repository.

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

It is recommanded to clone with the _recursive_ option to automatically fetch the included _git submodules_ (namely, Drupalizer, our tasks-automation tool).

TIP: If you properly init the submodule, you should have a _drupalizer_ directory at the repository root.

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

 $ cp conf/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.

86
include::drupalizer/README.adoc[]
87
88
89
90
91
92
93
94
95

== 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

96
97
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.
98
99

Visit https://github.com/asciidoctor[Asciidoctor @ *GitHub*] for more informations.
100
The {doc-asciidoctor}[AsciiDoc Recommanded Practices] is also recommanded.
101

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

104
 $ asciidoctor README.adoc
105
106
107
108
109
110

The README.html is generated in the current directory.

Asciidoctor provides a native PDF renderer for Asciidoc. Still in alpha, but worth the try. Please follow the instructions on the official documentation to
install it, then issue following command:

111
 $ asciidoctor-pdf README.adoc
112
113

The README.pdf file shall be created in the current directory.