91a21c2729
- 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
39 lines
1.3 KiB
YAML
39 lines
1.3 KiB
YAML
site_name: Shaarli Documentation
|
|
repo_url: https://github.com/shaarli/Shaarli
|
|
edit_uri: edit/master/doc/md
|
|
site_description: The personal, minimalist, super-fast, database free, bookmarking service
|
|
theme:
|
|
name: readthedocs
|
|
custom_dir: doc/custom_theme/
|
|
docs_dir: doc/md
|
|
site_dir: doc/html
|
|
# Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings:
|
|
# - https://github.com/shaarli/Shaarli/issues/1179
|
|
# - https://github.com/rtfd/readthedocs.org/issues/4314
|
|
# strict: true
|
|
|
|
pages:
|
|
- Home: index.md
|
|
- Setup:
|
|
- Server configuration: Server-configuration.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
|
|
- Upgrade and migration: Upgrade-and-migration.md
|
|
- Usage:
|
|
- Usage: Usage.md
|
|
- REST API: REST-API.md
|
|
- Community and Related software: Community-and-related-software.md
|
|
- Development:
|
|
- 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
|