From 91a21c272960889afd4eaa431a3d29b7785b6efc Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 16 May 2020 12:54:51 +0200 Subject: **General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization** - standardize page names, rework documentation structure, update TOC - use same example paths everywhere - level 1 titles on all pages - fix broken links - .md suffix on all page links (works both from readthedocs and github repository views) **Server:** A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration. - server: move most server-related info to server-configuration.md, cleanup/shorten - server: update list of php dependencies/libraries, link to composer.json - server: installation: support 3 install methods (from release zip, from sources, using docker) - server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not - server: add example/basic usage of certbot - server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root - server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example - server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files - server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section - server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here - server: simplify phpinfo documentation - server: move backup and restore information to dedicated page - docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet - troubleshooting: move all troubleshooting documentation to troubleshooting.md **Usage:** - index: add getting started section on index page - features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list - shaarli configuration: add note about configuring from web interface **Removed:** - remove obsolete/orphan images - remove obsolete shaarchiver example - remove outdated "decode datastore content" snippet **Development:** - development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory - development: Merge several pages to development.md - **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag) - **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details - development: directory structure: add note about required file permissions - .travis-ci.yml: add comments - .htaccess: add comment --- doc/md/Directory-structure.md | 54 ------------------------------------------- 1 file changed, 54 deletions(-) delete mode 100644 doc/md/Directory-structure.md (limited to 'doc/md/Directory-structure.md') diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md deleted file mode 100644 index c0b49393..00000000 --- a/doc/md/Directory-structure.md +++ /dev/null @@ -1,54 +0,0 @@ -## Directory structure - -Here is the directory structure of Shaarli and the purpose of the different files: - -```bash - index.php # Main program - application/ # Shaarli classes - ├── LinkDB.php - - ... - - └── Utils.php - tests/ # Shaarli unitary & functional tests - ├── LinkDBTest.php - - ... - - ├── utils # utilities to ease testing - │ └── ReferenceLinkDB.php - └── UtilsTest.php - assets/ - ├── common/ # Assets shared by multiple themes - ├── ... - ├── default/ # Assets for the default template, before compilation - ├── fonts/ # Font files - ├── img/ # Images used by the default theme - ├── js/ # JavaScript files in ES6 syntax - ├── scss/ # SASS files - └── vintage/ # Assets for the vintage template, before compilation - └── ... - COPYING # Shaarli license - inc/ # static assets and 3rd party libraries - └── rain.tpl.class.php # RainTPL templating library - images/ # Images and icons used in Shaarli - data/ # data storage: bookmark database, configuration, logs, banlist... - ├── config.json.php # Shaarli configuration (login, password, timezone, title...) - ├── datastore.php # Your link database (compressed). - ├── ipban.php # IP address ban system data - ├── lastupdatecheck.txt # Update check timestamp file - └── log.txt # login/IPban log. - tpl/ # RainTPL templates for Shaarli. They are used to build the pages. - ├── default/ # Default Shaarli theme - ├── fonts/ # Font files - ├── img/ # Images - ├── js/ # JavaScript files compiled by Babel and compatible with all browsers - ├── css/ # CSS files compiled with SASS - └── vintage/ # Legacy Shaarli theme - └── ... - cache/ # thumbnails cache - # This directory is automatically created. You can erase it anytime you want. - tmp/ # Temporary directory for compiled RainTPL templates. - # This directory is automatically created. You can erase it anytime you want. - vendor/ # Third-party dependencies. This directory is created by Composer -``` -- cgit v1.2.3