From 2e9fa8f4b7cccc29806307e341c09319e3912c78 Mon Sep 17 00:00:00 2001 From: Diogo Cordeiro Date: Sun, 2 Jun 2019 12:59:37 +0100 Subject: [PATCH] [DOCUMENTATION] Reorganize documentation --- EVENTS.txt => DOCUMENTATION/DEVELOPERS/EVENTS.txt | 0 .../DEVELOPERS/Plugins/README.md | 0 .../SYSTEM_ADMINISTRATORS/CONFIGURE | 0 .../SYSTEM_ADMINISTRATORS/PLUGINS.txt | 0 .../socialfy-another-domain}/README.txt | 0 .../dot-well-known/host-meta | 0 .../dot-well-known/webfinger/example@example.com.xml | 0 .../dot-well-known/webfinger/index.php | 0 .../upgrade_from/STATUSNET/README.md | 0 .../webserver_conf/htaccess.sample | 0 .../webserver_conf/lighttpd.conf.example | 0 .../webserver_conf/nginx.conf.sample | 1 - INSTALL | 6 ++++++ TODO.SOCIAL | 12 ------------ plugins/README.md | 2 +- 15 files changed, 7 insertions(+), 14 deletions(-) rename EVENTS.txt => DOCUMENTATION/DEVELOPERS/EVENTS.txt (100%) rename plugins/doc/Plugin_development.md => DOCUMENTATION/DEVELOPERS/Plugins/README.md (100%) rename CONFIGURE => DOCUMENTATION/SYSTEM_ADMINISTRATORS/CONFIGURE (100%) rename PLUGINS.txt => DOCUMENTATION/SYSTEM_ADMINISTRATORS/PLUGINS.txt (100%) rename {socialfy-another-domain => DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain}/README.txt (100%) rename {socialfy-another-domain => DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain}/dot-well-known/host-meta (100%) rename {socialfy-another-domain => DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain}/dot-well-known/webfinger/example@example.com.xml (100%) rename {socialfy-another-domain => DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain}/dot-well-known/webfinger/index.php (100%) rename UPGRADE => DOCUMENTATION/SYSTEM_ADMINISTRATORS/upgrade_from/STATUSNET/README.md (100%) rename htaccess.sample => DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/htaccess.sample (100%) rename lighttpd.conf.example => DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/lighttpd.conf.example (100%) rename nginx.conf.sample => DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/nginx.conf.sample (98%) delete mode 100644 TODO.SOCIAL diff --git a/EVENTS.txt b/DOCUMENTATION/DEVELOPERS/EVENTS.txt similarity index 100% rename from EVENTS.txt rename to DOCUMENTATION/DEVELOPERS/EVENTS.txt diff --git a/plugins/doc/Plugin_development.md b/DOCUMENTATION/DEVELOPERS/Plugins/README.md similarity index 100% rename from plugins/doc/Plugin_development.md rename to DOCUMENTATION/DEVELOPERS/Plugins/README.md diff --git a/CONFIGURE b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/CONFIGURE similarity index 100% rename from CONFIGURE rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/CONFIGURE diff --git a/PLUGINS.txt b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/PLUGINS.txt similarity index 100% rename from PLUGINS.txt rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/PLUGINS.txt diff --git a/socialfy-another-domain/README.txt b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/README.txt similarity index 100% rename from socialfy-another-domain/README.txt rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/README.txt diff --git a/socialfy-another-domain/dot-well-known/host-meta b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/dot-well-known/host-meta similarity index 100% rename from socialfy-another-domain/dot-well-known/host-meta rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/dot-well-known/host-meta diff --git a/socialfy-another-domain/dot-well-known/webfinger/example@example.com.xml b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/dot-well-known/webfinger/example@example.com.xml similarity index 100% rename from socialfy-another-domain/dot-well-known/webfinger/example@example.com.xml rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/dot-well-known/webfinger/example@example.com.xml diff --git a/socialfy-another-domain/dot-well-known/webfinger/index.php b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/dot-well-known/webfinger/index.php similarity index 100% rename from socialfy-another-domain/dot-well-known/webfinger/index.php rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/socialfy-another-domain/dot-well-known/webfinger/index.php diff --git a/UPGRADE b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/upgrade_from/STATUSNET/README.md similarity index 100% rename from UPGRADE rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/upgrade_from/STATUSNET/README.md diff --git a/htaccess.sample b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/htaccess.sample similarity index 100% rename from htaccess.sample rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/htaccess.sample diff --git a/lighttpd.conf.example b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/lighttpd.conf.example similarity index 100% rename from lighttpd.conf.example rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/lighttpd.conf.example diff --git a/nginx.conf.sample b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/nginx.conf.sample similarity index 98% rename from nginx.conf.sample rename to DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/nginx.conf.sample index 18d9b932a6..496d42029b 100644 --- a/nginx.conf.sample +++ b/DOCUMENTATION/SYSTEM_ADMINISTRATORS/webserver_conf/nginx.conf.sample @@ -21,7 +21,6 @@ server { # Server name # FIXME: Change "social.example.org" to your site's domain name -# GNU social MUST be installed in the domain root server_name social.example.org; # SSL diff --git a/INSTALL b/INSTALL index 85a9ebccfb..894554c0eb 100644 --- a/INSTALL +++ b/INSTALL @@ -16,6 +16,7 @@ TABLE OF CONTENTS * After installation - Backups - Upgrading +* Additional configuration Prerequisites ============= @@ -454,3 +455,8 @@ Upgrading Upgrading is strongly recommended to stay up to date with security fixes and new features. For instructions on how to upgrade GNU social code, please see the UPGRADE file. + +Additional configuration +------------------------ + +Please refer to DOCUMENTATION/SYSTEM_ADMINISTRATORS/CONFIGURE for information. diff --git a/TODO.SOCIAL b/TODO.SOCIAL deleted file mode 100644 index 4d4866f0f6..0000000000 --- a/TODO.SOCIAL +++ /dev/null @@ -1,12 +0,0 @@ -Things to be done -================= - -* Create a theme for GNU social - -* Create a set of plugins to give StatusNet a more social-network UI - -* Work on improvements for annoying things in StatusNet (ie. no - redirect to login page when you need to be logged in, etc) - -* Work on adding further Activities, such as sharing photos/video, - events, UI for managing relationships. \ No newline at end of file diff --git a/plugins/README.md b/plugins/README.md index d1e1dd8196..4eb5d76c62 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -17,5 +17,5 @@ Plugins are documented in their own directories. Additional information on using and developing plugins can be found at the following locations: -* [Plugin Development](doc/Plugin_development.md) +* [Plugin Development](../DOCUMENTATION/DEVELOPERS/Plugins/README.md) * [Community Plugins](https://git.gnu.io/gnu/gnu-social/wikis/GNU-Social-Community-Plugins) -- 2.39.5