Cleaned up documentation for installation process #2403

nicosomb · 2016-10-08T13:15:29Z

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Documentation	yes
Translation	yes
Fixed tickets	#2370
License	MIT

You can now install wallabag with only 3 commands:

git clone https://github.com/wallabag/wallabag.git
cd wallabag
make install

We won't need to update wallabag for each new release with the new tag.

nicosomb · 2016-10-08T13:18:38Z

It's a quick draft. Today, we have so many pages which tell us how to install wallabag. I wanted to standardize the installation process.

I need to review the update process. But I want your opinion about this first draft.
I need to update wallabag.org website with latest package md5 checksum.

If it's OK, I also need the help of german translators in this PR (ping @jlnostr @Strubbl).

j0k3r · 2016-10-08T18:02:13Z

README.md

-    git checkout 2.1.1
-    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
-    php bin/console wallabag:install --env=prod
+    ./install.sh
    php bin/console server:run --env=prod


You can remove the indentation here

j0k3r · 2016-10-08T18:03:56Z

install.sh

+#! /usr/bin/env bash
+
+TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
+git checkout $TAG


--force? To avoid error if user has changed some files in the repo?

It's an installation, so no changed files I think

tcitworld · 2016-10-09T11:32:55Z

Instead of using an install.sh, could we this time use make ?
I could see :

make install: like install.sh
make update : update an existing installation
make build : run grunt
make tests : run ant prepare && phpunit
make release : produce a wallabag release
make travis : make things for travis

nicosomb · 2016-10-09T16:48:26Z

👍 I'll look that tomorrow

tcitworld · 2016-10-09T18:21:54Z

I like your vision of tomorrow.

tcitworld · 2016-10-09T21:29:43Z

Makefile

+update: ## Update the wallabag installation to the latest version
+	@sh scripts/update.sh $(ENV)
+
+run: ## Run the wallabag server


build-in server

tcitworld · 2016-10-09T21:32:18Z

Don't forget to add that make is required now.

j0k3r · 2016-10-10T07:13:46Z

scripts/release.sh

@@ -0,0 +1,17 @@
+#! /usr/bin/env bash
+


Maybe you can put an example on how to launch that command (in comment)?

We launch this command from Makefile. Need to document here too?

I still more documentation than none :)

Fix #2415

tcitworld · 2016-10-10T07:28:38Z

Makefile

-run: ## Run the wallabag server
-	php bin/console server:run --env=$(ENV)
+run: ## Run the wallabag built-in server
+	@php bin/console server:run --env=$(ENV)

 build: ## Run grunt
 	@grunt

 test: ## Launch wallabag testsuite


Maybe a regular composer installwill be needed to install phpunit ?

A composer install before launching testsuite?

Hmm, this takes time.
Should be

if vendor/phpunit/ not exists composer install tests

Following #2417

tcitworld · 2016-10-10T09:37:48Z

RELEASE_PROCESS.md

-    git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1
-    SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev
-    tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
+make releas emaster /tmp wllbg-release prod


make release master

tcitworld · 2016-10-10T09:38:39Z

docs/de/user/installation.rst

@@ -6,6 +6,19 @@ Voraussetzungen

 wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.

+.. note::
+Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.


Why is there french here ?

I don't know. It's not me. I'm sorry.

tcitworld · 2016-10-10T09:39:48Z

docs/en/user/android.rst


 .. image:: ../../img/user/android_configuration_connection_test.en.png
    :alt: Connection test with your wallabag data
    :align: center

-The connection test shall finish with success. If not, you need to fix this first until you proceed. 
+The connection test shall finish with success. If not, you need to fix this first until you proceed.


shall -> should

tcitworld · 2016-10-10T09:40:01Z

docs/en/user/android.rst

@@ -65,7 +65,7 @@ After hitting the save button, you get the following screen. The app proposes to
    :alt: Settings saved the first time
    :align: center

-Finally after the syncronisation finished successfully, you are presented the list of unread articles. 
+Finally after the syncronisation finished successfully, you are presented the list of unread articles.


you are presented to

tcitworld · 2016-10-10T09:42:17Z

Please also add a page to explain the meaning of each parameter in parameters.yml.

#2392

nicosomb · 2016-10-10T09:42:44Z

@tcitworld 😭

nicosomb · 2016-10-10T11:02:27Z

I added a draft for parameters explanation.

j0k3r · 2016-10-10T12:52:23Z

We should update this too:

add step to enable redis/rabbitmq in async import
fix link in import section in all languages (http://doc.wallabag.org/en/master/user/import.html)

j0k3r · 2016-10-10T14:36:56Z

Can we also add some doc about launching test in local? (requested from a user)

nicosomb · 2016-10-10T14:40:45Z

@j0k3r https://github.com/wallabag/wallabag/blob/fa4c39b37c1e1a1b52739a070775e9ba0fafe802/docs/en/developer/testsuite.rst ?

j0k3r · 2016-10-10T14:42:20Z

Awesome (missed that commit)

nicosomb added 2 commits October 8, 2016 15:10

Cleaned up documentation for installation process

7eff473

Chmoded install.sh

7c256ff

nicosomb added Documentation Work in progress labels Oct 8, 2016

j0k3r reviewed Oct 8, 2016

View reviewed changes

Strubbl added 2 commits October 8, 2016 20:25

update German installation.rst

5334381

update German installation.rst

5112b35

First draft for Makefile

d8507ad

nicosomb added 4 commits October 9, 2016 21:06

Update Makefile

46aeaab

Update Makefile

26490a8

Created scripts folder to store update/install/release process

4e7863c

Changed the default command when we launch make

02edf07

tcitworld reviewed Oct 9, 2016

View reviewed changes

j0k3r added 2 commits October 10, 2016 09:11

Update README.md

3175e33

Update RELEASE_PROCESS.md

edc8bc0

j0k3r reviewed Oct 10, 2016

View reviewed changes

Added documentation about testsuite

84e3c36

Fix #2415

tcitworld reviewed Oct 10, 2016

View reviewed changes

nicosomb modified the milestone: 2.1.2 Oct 10, 2016

nicosomb and others added 4 commits October 10, 2016 10:20

Update documentation

7c12253

Update upgrade documentation

7c1ce28

Typos in upgrade doc

eb54d33

Add -dev version

6b1317a

Following #2417

tcitworld requested changes Oct 10, 2016

View reviewed changes

Added page about parameters.yml

ed11d7f

Use table for parameters.yml

035513b

nicosomb added 2 commits October 10, 2016 15:38

Fixed links on import page

c15f083

Added steps about Redis/RabbitMQ activation

fa4c39b

j0k3r approved these changes Oct 10, 2016

View reviewed changes

nicosomb added Ready for review and removed Work in progress labels Oct 10, 2016

tcitworld approved these changes Oct 10, 2016

View reviewed changes

j0k3r merged commit bccf7a7 into master Oct 10, 2016

j0k3r deleted the cleanup-install-process-in-doc branch October 10, 2016 14:58

j0k3r mentioned this pull request Oct 11, 2016

German documentation: Wallabag updaten - wrong links #2423

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cleaned up documentation for installation process #2403

Cleaned up documentation for installation process #2403

nicosomb commented Oct 8, 2016 •

edited

nicosomb commented Oct 8, 2016 •

edited

j0k3r Oct 8, 2016

j0k3r Oct 8, 2016

nicosomb Oct 9, 2016

tcitworld commented Oct 9, 2016 •

edited

nicosomb commented Oct 9, 2016

tcitworld commented Oct 9, 2016

tcitworld Oct 9, 2016

tcitworld commented Oct 9, 2016

j0k3r Oct 10, 2016

nicosomb Oct 10, 2016

j0k3r Oct 10, 2016

tcitworld Oct 10, 2016

nicosomb Oct 10, 2016

tcitworld Oct 10, 2016

tcitworld Oct 10, 2016

tcitworld Oct 10, 2016

nicosomb Oct 10, 2016

tcitworld Oct 10, 2016

tcitworld Oct 10, 2016

tcitworld commented Oct 10, 2016 •

edited

nicosomb commented Oct 10, 2016

nicosomb commented Oct 10, 2016

j0k3r commented Oct 10, 2016 •

edited by nicosomb

j0k3r commented Oct 10, 2016

nicosomb commented Oct 10, 2016

j0k3r commented Oct 10, 2016

Cleaned up documentation for installation process #2403

Cleaned up documentation for installation process #2403

Conversation

nicosomb commented Oct 8, 2016 • edited

nicosomb commented Oct 8, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tcitworld commented Oct 9, 2016 • edited

nicosomb commented Oct 9, 2016

tcitworld commented Oct 9, 2016

Choose a reason for hiding this comment

tcitworld commented Oct 9, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tcitworld commented Oct 10, 2016 • edited

nicosomb commented Oct 10, 2016

nicosomb commented Oct 10, 2016

j0k3r commented Oct 10, 2016 • edited by nicosomb

j0k3r commented Oct 10, 2016

nicosomb commented Oct 10, 2016

j0k3r commented Oct 10, 2016

nicosomb commented Oct 8, 2016 •

edited

nicosomb commented Oct 8, 2016 •

edited

tcitworld commented Oct 9, 2016 •

edited

tcitworld commented Oct 10, 2016 •

edited

j0k3r commented Oct 10, 2016 •

edited by nicosomb