2 commits
Author | SHA1 | Message | Date | |
---|---|---|---|---|
|
add670b8ab
|
doc: fix mkdocs build warnings/relative links
INFO - Cleaning site directory INFO - Building documentation to directory: /home/live/GIT/Shaarli/doc/html INFO - Doc file 'index.md' contains an unrecognized relative link 'Usage#tag-cloud', it was left as is. Did you mean 'Usage.md#tag-cloud'? INFO - Doc file 'index.md' contains an unrecognized relative link 'Usage#picture-wall', it was left as is. Did you mean 'Usage.md#picture-wall'? INFO - Doc file 'index.md' contains an unrecognized relative link 'Usage#import-export', it was left as is. Did you mean 'Usage.md#import-export'? INFO - Doc file 'Community-and-related-software.md' contains an unrecognized relative link 'REST-API', it was left as is. Did you mean 'REST-API.md'? INFO - Doc file 'Community-and-related-software.md' contains an unrecognized relative link 'Theming', it was left as is. INFO - Doc file 'Installation.md' contains an unrecognized relative link 'dev/Development#third-party-libraries', it was left as is. Did you mean 'dev/Development.md#third-party-libraries'? INFO - Doc file 'Installation.md' contains an unrecognized relative link 'Upgrade-and-migration', it was left as is. Did you mean 'Upgrade-and-migration.md'? INFO - Doc file 'Plugins.md' contains an unrecognized relative link 'Shaarli-configuration', it was left as is. Did you mean 'Shaarli-configuration.md'? INFO - Doc file 'REST-API.md' contains an unrecognized relative link 'Server-configuration', it was left as is. Did you mean 'Server-configuration.md'? INFO - Doc file 'Reverse-proxy.md' contains an unrecognized relative link 'Shaarli-configuration', it was left as is. Did you mean 'Shaarli-configuration.md'? INFO - Doc file 'Server-configuration.md' contains an unrecognized relative link 'Directory-structure', it was left as is. INFO - Doc file 'Shaarli-configuration.md' contains an unrecognized relative link 'Translations', it was left as is. INFO - Doc file 'dev/Development.md' contains an unrecognized relative link 'Unit-tests', it was left as is. Did you mean 'Unit-tests.md'? INFO - Doc file 'dev/Development.md' contains an unrecognized relative link 'GnuPG-signature', it was left as is. Did you mean 'GnuPG-signature.md'? INFO - Doc file 'dev/GnuPG-signature.md' contains an unrecognized relative link 'Release Shaarli', it was left as is. INFO - Doc file 'dev/Theming.md' contains an unrecognized relative link 'Shaarli-configuration', it was left as is. INFO - Doc file 'dev/Translations.md' contains an unrecognized relative link 'Theming', it was left as is. Did you mean 'Theming.md'? INFO - Documentation built in 0.40 seconds |
||
|
91a21c2729 |
**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 |
Renamed from doc/md/Translations.md (Browse further)