Commit 5953b1b6 authored by Emmanuel Milou's avatar Emmanuel Milou
Browse files

Add Asciidoctor documentation

parent be9b835e
......@@ -29,3 +29,5 @@ sflinux
# Ignore ssh keys
= SFL Boilerplate: a generic template for Drupal projects
:keywords: Drupal, SFL, SFLinux, AsciiDoc, Asciidoctor
:page-layout: base
:page-description: {description}
:page-keywords: {keywords}
:toc-placement: preamble
:toc: right
:icons: font
:idseparator: -
:source-highlighter: highlight.js
:mdash: —
:language: asciidoc
:source-language: {language}
:imagesdir: ../images
:includedir: _includes
// Refs
/ __/ __/ / / _/ |/ / / / / |/_/
_\ \/ _// /___/ // / /_/ /> <
/___/_/ /____/___/_/|_/\____/_/|_|
// (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
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/ drupalizer/
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:
More on Drush and Makefile:
== 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.
This repo contains a recipe for making a [Docker]( image for Drupal.
To build, make sure you have Docker [installed](
This will try to go in line with [Drupal automated-testing](
## Install docker:
First, check that your APT system can deal with https URLs: the file /usr/lib/apt/methods/https should exist. If it doesn't, you need to install the package apt-transport-https.
[ -e /usr/lib/apt/methods/https ] || {
apt-get update
apt-get install apt-transport-https
Then, add the Docker repository key to your local keychain.
sudo apt-key adv --keyserver hkp:// --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9
Add the Docker repository to your apt sources list, update and install the lxc-docker package.
sudo sh -c "echo deb docker main > /etc/apt/sources.list.d/docker.list"
sudo apt-get update
sudo apt-get install lxc-docker
Add your user to the docker group to be able to execute docker command wihtout sudo
adduser <user> docker
## This project depend of [Docker-BaseImage](
This project use like [Docker-BaseImage]( base image. Then we first need to clone this project and build the sflinux/baseimage. Information about build this image is here [Docker-BaseImage](, but in resume you need:
Clone the repo some where
git clone
cd docker-lampd
and then build it:
sudo docker build -t sflinux/baseimage .
This can take a while but should eventually return a command prompt. It's done when it says "Successfully built {hash}"
That's it!
## Now is time to build our project sfl-boilerplate.
Is almost the same procedure
Clone the repo some where but you need to clone the branch docker
git clone -b docker
Get the submodule to deploy the site:
cd sfl-boilerplate
git submodule init
git submodule update
Copy and change at your needs the file from the directory /deploy to /drupy:
cp deploy/ drupy/
nano drupay/
Build the site and setup all configurations:
cd drupy
fab local_setup
That's it!
## Contributing
Feel free to fork and contribute to this code. :)
## Authors
Created and maintained by [Ernesto Rodriguez Ortiz][author] (>)
## License
GPL v2
# site-update
# Script de mise à jour d'un site
# Pour mettre à jour un site :
# - modifier le fichier .make du profil d'installation
# - ./site-update
# set -x
# set -e
# Mise a jour du core et des modules
drush make ../../build/sfl-boilerplate.make -y || exit 1
# Déclenchement des éventuels hook_install_N()
drush updb -y
# Reconfiguration de l'environnement
drush d-conf
# Vidage des caches
drush cc all
exit 0;
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment