From 7c1225347db8b516cc268709939f6b359bc283c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 10:20:32 +0200 Subject: [PATCH] Update documentation --- Makefile | 1 + README.md | 5 ++--- RELEASE_PROCESS.md | 27 +++++++++++++-------------- docs/de/user/installation.rst | 5 ++--- docs/en/user/installation.rst | 9 ++++----- docs/fr/user/installation.rst | 5 ++--- scripts/install.sh | 2 ++ scripts/release.sh | 2 ++ scripts/update.sh | 2 ++ 9 files changed, 30 insertions(+), 28 deletions(-) diff --git a/Makefile b/Makefile index e99367f67..1c6c0d537 100755 --- a/Makefile +++ b/Makefile @@ -24,6 +24,7 @@ build: ## Run grunt @grunt test: ## Launch wallabag testsuite + @if [ ! -d "vendor/phpunit" ]; then composer install; fi @ant prepare && vendor/phpunit/phpunit/phpunit -v release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`). diff --git a/README.md b/README.md index 8de3279de..c94882884 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,8 @@ Then you can install wallabag by executing the following commands: ``` git clone https://github.com/wallabag/wallabag.git -cd wallabag -./install.sh -php bin/console server:run --env=prod +cd wallabag && make install +make run ``` # License diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index 627bd844c..767f5e260 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -15,23 +15,22 @@ During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`. - Run these commands to create the tag: - ``` - git checkout master - git pull origin master - git checkout -b release-$LAST_WALLABAG_RELEASE - SYMFONY_ENV=prod composer up --no-dev - git add --force composer.lock - git commit -m "Release wallabag $LAST_WALLABAG_RELEASE" - git push origin release-$LAST_WALLABAG_RELEASE - ``` +``` +git checkout master +git pull origin master +git checkout -b release-$LAST_WALLABAG_RELEASE +SYMFONY_ENV=prod composer up --no-dev +git add --force composer.lock +git commit -m "Release wallabag $LAST_WALLABAG_RELEASE" +git push origin release-$LAST_WALLABAG_RELEASE +``` - Create a new pull request with this title `DON'T MERGE Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI. -- Run these commands to create the package (you need to clone `https://github.com/wallabag/releaser`) : +- Run these command to create the package: - ``` - cd releaser/ - ./releaser.sh $LAST_WALLABAG_RELEASE - ``` +``` +make releas emaster /tmp wllbg-release prod +``` - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package. - Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**). diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index bee3249b0..2bb86269b 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -57,14 +57,13 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: :: - php bin/console server:run --env=prod + make run und wallabag unter http://deineserverip:8000 erreichen. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 0920b9767..e08e0306f 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -56,14 +56,13 @@ To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install To start PHP's build-in server and test if everything did install correctly, you can do: :: - php bin/console server:run --env=prod + make run And access wallabag at http://yourserverip:8000 @@ -240,12 +239,12 @@ Rights access to the folders of the project Test environment ~~~~~~~~~~~~~~~~ -When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. +When we just want to test wallabag, we just run the command ``make run`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. Production environment ~~~~~~~~~~~~~~~~~~~~~~ -As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. +As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 55614d729..b32707f8d 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -54,14 +54,13 @@ Pour installer wallabag, vous devez exécuter ces commandes : :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : :: - php bin/console server:run --env=prod + make run Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 diff --git a/scripts/install.sh b/scripts/install.sh index 755aac1c7..54d0bb785 100644 --- a/scripts/install.sh +++ b/scripts/install.sh @@ -1,4 +1,6 @@ #! /usr/bin/env bash +# You can execute this file to install wallabag +# eg: `sh install.sh prod` ENV=$1 TAG=$(git describe --tags $(git rev-list --tags --max-count=1)) diff --git a/scripts/release.sh b/scripts/release.sh index 3d0964304..e118b87ed 100644 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -1,4 +1,6 @@ #! /usr/bin/env bash +# You can execute this file to create a new package for wallabag +# eg: `sh release.sh master /tmp wllbg-release prod` VERSION=$1 TMP_FOLDER=$2 diff --git a/scripts/update.sh b/scripts/update.sh index 48281210d..b920a829b 100644 --- a/scripts/update.sh +++ b/scripts/update.sh @@ -1,4 +1,6 @@ #! /usr/bin/env bash +# You can execute this file to update wallabag +# eg: `sh update.sh prod` ENV=$1 TAG=$(git describe --tags $(git rev-list --tags --max-count=1))