Merge pull request #644 from glensc/import-wiki

.gitmodules

@@ -1,7 +1,3 @@
-[submodule "docs/wiki"]
-	path = docs/wiki
-	url = https://github.com/eventum/eventum.wiki.git
-    pushurl = git://github.com/eventum/eventum.wiki.git
 [submodule "contrib/shell-semver"]
 	path = contrib/shell-semver
 	url = https://github.com/fmahnke/shell-semver

bin/releng/build-release.sh

@@ -48,16 +48,6 @@ update_timestamps() {
 	done
 }
 
-# rename wiki pages to be compatible with windows filesystems
-# https://github.com/eventum/eventum/issues/180
-wiki_pages_rename() {
-	echo >&2 "Renaming wiki pages"
-	find $dir -name '*:*' | while read file; do
-		f=$(echo "$file" | sed -e 's/:/_/g')
-		mv -v "$file" "$f"
-	done
-}
-
 vcs_checkout() {
 	set -x
 	local submodule dir=$dir absdir
@@ -92,8 +82,6 @@ vcs_checkout() {
 
 	# reset submodules to previous state
 	git submodule update
-
-	wiki_pages_rename
 }
 
 po_checkout() {

bin/releng/create-release.sh

@@ -43,20 +43,12 @@ cd $topdir
 git fetch origin
 git rebase origin/master
 
-cd $topdir/docs/wiki
-git checkout master
-git pull --rebase
-cd ../..
-
 cache_gpg_askpass
 
 patch_changelog "s/^## \[$(quote "$VERSION")\] *-* *$/& - $RELDATE/"
 patch_changelog "/^\[$(quote "$VERSION")\]/ s/\.\.\.master/...$TAG/"
 git commit -am "prepare for $VERSION release"
 
-cd $topdir/docs/wiki
-git tag $TAG
-
 cd $topdir
 GIT_COMMITTER_EMAIL=$SIGN_KEY git tag -s -u "$SIGN_KEY" "$TAG" -m "release $TAG"
 
@@ -67,5 +59,3 @@ cd $topdir
 git push origin master
 git push origin $TAG
 git push launchpad
-cd $topdir/docs/wiki
-git push origin $TAG

docs/wiki/Attachments.md

@@ -0,0 +1,70 @@
+Since Eventum 3.3.0 attachments are abstracted using [Flysystem](https://flysystem.thephpleague.com/). Users upgrading from previous versions do not need to configure anything as a legacy adapter is provided for existing attachments. New attachments will be stored in the `attachment_path` and `attachment_chunk` tables using the [Flysystem-pdo](https://github.com/IntegralSoftware/flysystem-pdo-adapter) adapter.
+
+# Advanced Use
+
+Three adapters are included:
+* legacy: Read only adapter for accessing pre 3.3.0 attachments
+* pdo: flysystem-pdo adapter used by default for new attachments
+* local: local filesystem adapter if you wish to store attachments on disk instead of the database
+
+Advanced users can change to a different adapter by editing setup.php in your configuration file and adding/changing the default adapter.
+
+```php
+    'attachments' => [
+        'default_adapter' => 'local',
+    ],
+```
+
+You can define additional adapters and pass options to adapters as well.
+```php
+    'attachments' => [
+        'default_adapter' => 'local',
+        'adapters' => [
+            'local' => [
+                'class' => '\\League\\Flysystem\\Adapter\\Local',
+                'options' => ['/path/to/my/system/'],
+            ],
+        ],
+    ],
+```
+
+# Migrating existing attachments
+
+If you want to migrate your existing attachments to a new backend, use `migrate_storage_adapter.php` tool.
+
+Changing storage adapters has a risk of data loss and may require large amounts
+of disk space during the process. Make sure you fully understand the process
+and backup all data before proceeding.
+
+Verify that the attachments are reachable.
+
+```
+$ ./bin/migrate_storage_adapter.php --verify pdo
+Verifying data in 'pdo://' Adapter
+Preparing temporary table. Please wait...
+Verifying 1 file(s)
+
+$ ./bin/migrate_storage_adapter.php --verify legacy
+Verifying data in 'legacy://' Adapter
+Preparing temporary table. Please wait...
+Verifying 1516 file(s)
+```
+
+Perform actual migration
+
+```
+$ ./bin/migrate_storage_adapter.php --yes pdo local --limit=100
+Migrating data from 'pdo://' to 'local://'
+Preparing temporary table. Please wait...
+Moving 1 file(s)
+ 1/1 [============================] 100% < 1 sec/< 1 sec 6.8 MiB
+You might need to run 'OPTIMIZE TABLE attachment_chunk' to reclaim space from the database
+
+$ mysql -s eventum -e 'OPTIMIZE TABLE attachment_chunk'
+Table   Op      Msg_type        Msg_text
+eventum.attachment_chunk        optimize        status  OK
+```
+
+### Additional Reading
+
+See [PR#254](https://github.com/eventum/eventum/pull/254)

docs/wiki/Basic-User/Basic-User.md

@@ -0,0 +1,10 @@
+* Basic User Information
+ * [[Creating Issues|Basic-User:-Creating-Issues]]
+ * [[Editing Personal Preferences|Basic-User:-Editing-Preferences]]
+ * [[FAQ|Basic-User:-FAQ]]
+ * [[How Issues are Handled|Basic-User:-How-issues-are-handled-in-Eventum]]
+ * [[Listing Issues|Basic-User:-Listing-Issues]]
+ * [[Projects|Basic-User:-Projects]]
+ * [[RSS Feeds|Basic-User:-RSS-feeds]]
+ * [[Reports|Basic-User:-Reporting-System]]
+ * [[Working with Issues|Basic-User:-Working-with-Issues]]

docs/wiki/Basic-User/Basic-User_-Editing-Preferences.md

@@ -0,0 +1,13 @@
+### Editing Preferences
+
+![Preferences|right|400px](Preferences.png "fig:Preferences|right|400px") In this section you can change your account password, Full Name and email address (must be valid). This address will be used by the system to send email notifications whenever details about issues you are subscribed to changes.
+
+The default options for email notifications are used to pre-select the notification related fields when you report a new issue, or subscribe manually for changes in the issue details page.
+
+If available, you might change the language from the [[Available Languages|System-Advanced:-Localization]].
+
+You may also set the appropriate timezone where you live in this screen in order to display issues information with your local time, and all of the software will adjust the dates displayed in the system accordingly. Default Timezone is UTC.
+
+An important feature here is suscribing to certain notifications for each project: created and assigned issues, both default to Yes.
+
+You may also define your Email Signature, for including it when sending email from Eventum.