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 --- mkdocs.yml | 46 +++++++++++++++------------------------------- 1 file changed, 15 insertions(+), 31 deletions(-) (limited to 'mkdocs.yml') diff --git a/mkdocs.yml b/mkdocs.yml index cee2c5fb..2e201d03 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,41 +15,25 @@ site_dir: doc/html pages: - Home: index.md - Setup: - - Download and Installation: Download-and-Installation.md - - Upgrade and migration: Upgrade-and-migration.md - Server configuration: Server-configuration.md - - Server security: Server-security.md + - Installation: Installation.md + - Docker: Docker.md + - Reverse Proxy: Reverse-proxy.md + - Backup and restore: Backup-and-restore.md - Shaarli configuration: Shaarli-configuration.md - Plugins: Plugins.md -- Docker: - - Docker 101: docker/docker-101.md - - Shaarli images: docker/shaarli-images.md - - Reverse proxy configuration: docker/reverse-proxy-configuration.md - - Docker resources: docker/resources.md + - Upgrade and migration: Upgrade-and-migration.md - Usage: - - Browsing and searching: Browsing-and-searching.md - - Sharing content: Sharing-content.md - - RSS feeds: RSS-feeds.md + - Usage: Usage.md - REST API: REST-API.md - - Community & Related software: Community-&-Related-software.md -- Guides: - - Install Shaarli on Debian 9 with Docker: guides/install-shaarli-with-debian9-and-docker.md - - Backup, restore, import and export: guides/backup-restore-import-export.md - - Various hacks: guides/various-hacks.md + - Community and Related software: Community-and-related-software.md - Development: - - Development guidelines: Development-guidelines.md - - Continuous integration tools: Continuous-integration-tools.md - - GnuPG signature: GnuPG-signature.md - - Directory structure: Directory-structure.md - - Link Structure: Link-structure.md - - 3rd party libraries: 3rd-party-libraries.md - - Plugin System: Plugin-System.md - - Release Shaarli: Release-Shaarli.md - - Versioning and Branches: Versioning-and-Branches.md - - Security: Security.md - - Static analysis: Static-analysis.md - - Translations: Translations.md - - Theming: Theming.md - - Unit tests: Unit-tests.md -- FAQ: FAQ.md + - Development: dev/Development.md + - Versioning: dev/Versioning.md + - GnuPG signature: dev/GnuPG-signature.md + - Plugin System: dev/Plugin-system.md + - Translations: dev/Translations.md + - Release Shaarli: dev/Release-Shaarli.md + - Theming: dev/Theming.md + - Unit tests: dev/Unit-tests.md - Troubleshooting: Troubleshooting.md -- cgit v1.2.3