diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,85 @@ +# Installation instructions + +The paths are hard-coded and absolute so you will need to create a new user +called **docs** and some hard-coded directory. + +```bash +useradd --create-home docs +sudo su docs # log as the new user +cd ~ +# see https://techbase.kde.org/Development/Git/Configuration#URL_Renaming for kde: prefix +git clone kde:websites/docs-kde-org docs +``` + +Next is the apache configuration, you can find an example in `apache-docs.kde.org.conf` +for production use. For development you can use this one. + +``` + + ServerAdmin webmaster@kde.org + ServerName docs.localhost + DocumentRoot /srv/www/docs.kde.org/html/ + + ScriptAlias /docsearch/ /usr/lib/cgi-bin/omega/ + Alias /images/xapian-omega /usr/share/images/xapian-omega + SetEnv OMEGA_CONFIG_FILE /srv/www/docs.kde.org/omega/omega.conf + + ErrorLog ${APACHE_LOG_DIR}/docs.kde.org-error.log + CustomLog ${APACHE_LOG_DIR}/docs.kde.org.log combined + + RewriteEngine On + RewriteRule ^/docs/([^/]*)/?$ /index.php?branch=stable&language=$1 [L,QSA] + RewriteRule ^/(development|stable|kde3)/common/ - [L] + RewriteRule ^/development/([^/]*)/?$ /index.php?branch=development&language=$1 [L,QSA] + RewriteRule ^/development/([^/]*)/([^/]+)/?$ /index.php?branch=development&language=$1&package=$2 [L,QSA] + RewriteRule ^/development/([^/]*)/([^/]+)/([^/]+)/?$ /index.php?branch=development&language=$1&package=$2&application=$3 [L,QSA] + RewriteRule ^/development/([^/]*)/([^/]+)/([^/]+)/(.+)$ /index.php?branch=development&language=$1&package=$2&application=$3&path=$4 [L,QSA] + RewriteRule ^/stable/([^/]*)/?$ /index.php?branch=stable&language=$1 [L,QSA] + RewriteRule ^/stable/([^/]*)/([^/]+)/?$ /index.php?branch=stable&language=$1&package=$2 [L,QSA] + RewriteRule ^/stable/([^/]*)/([^/]+)/([^/]+)/?$ /index.php?branch=stable&language=$1&package=$2&application=$3 [L,QSA] + RewriteRule ^/stable/([^/]*)/([^/]+)/([^/]+)/(.+)$ /index.php?branch=stable&language=$1&package=$2&application=$3&path=$4 [L,QSA] + RewriteRule ^/kde3/([^/]*)/?$ /index.php?branch=kde3&language=$1 [L,QSA] + RewriteRule ^/kde3/([^/]*)/([^/]+)/?$ /index.php?branch=kde3&language=$1&package=$2 [L,QSA] + # Temporary rule for umbrello - remove not later than 6 months after the first Qt5release of Umbrello for Windows + # or the end of 2018, whatever it happens first. + RewriteRule ^/stable4/([^/]*)/kdesdk/umbrello/(.+)$ /index.php?branch=development&language=$1&application=umbrello&path=$2 [L,QSA] + + + Options +SymLinksIfOwnerMatch + AllowOverride None + Order allow,deny + Allow from all + Require all granted + + + + Options +ExecCGI + AllowOverride None + Order deny,allow + Allow from all + Require all granted + + +``` + +Let's generate some doc now. For development purpose we don't want to generate all the docs for all the language +so we can edit `/home/docs/docs/docgen_conf.ini` and uncomment some lines: + +``` +languages=en,ca +packages=calligra,frameworks,kde-workspace +``` + +To generate the doc, do: + +``` +cd /home/docs/docs && ./kdedocgen.py -r -g -s -l doclogconfig.ini -c docgen_conf.ini +cd /home/docs/docs && ./create_generated_used.php /home/docs/docs/work >/home/docs/website/generated_used.inc.php 2>/home/docs/logs/genused.log + +# only needed if you want to develop the xapian stuff +cd /home/docs/docs/search && nice -n 19 ./do_xapian_index.sh + +# updload to local server +rsync -azC --delete /home/docs/website/ /srv/www/docs.kde.org/html +``` +