]> git.immae.eu Git - github/shaarli/Shaarli.git/commit
**General rewording, proof-reading, deduplication, shortening, reordering, simplifica...
authornodiscc <nodiscc@gmail.com>
Sat, 16 May 2020 10:54:51 +0000 (12:54 +0200)
committernodiscc <nodiscc@gmail.com>
Sat, 12 Sep 2020 12:31:45 +0000 (14:31 +0200)
commit91a21c272960889afd4eaa431a3d29b7785b6efc
tree26e3ba62319964c5fd48d93fdfe47813d5dc9bf5
parent6128ab6a55430a2b705be31ff417c0c552a0db1f
**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
58 files changed:
.htaccess
.travis.yml
doc/md/3rd-party-libraries.md [deleted file]
doc/md/Backup-and-restore.md [new file with mode: 0644]
doc/md/Browsing-and-searching.md [deleted file]
doc/md/Community-and-related-software.md [moved from doc/md/Community-&-Related-software.md with 93% similarity]
doc/md/Continuous-integration-tools.md [deleted file]
doc/md/Development-guidelines.md [deleted file]
doc/md/Directory-structure.md [deleted file]
doc/md/Docker.md [new file with mode: 0644]
doc/md/Download-and-Installation.md [deleted file]
doc/md/FAQ.md [deleted file]
doc/md/Installation.md [new file with mode: 0644]
doc/md/Link-structure.md [deleted file]
doc/md/Plugins.md
doc/md/REST-API.md
doc/md/RSS-feeds.md [deleted file]
doc/md/Release-Shaarli.md [deleted file]
doc/md/Reverse-proxy.md [new file with mode: 0644]
doc/md/Security.md [deleted file]
doc/md/Server-configuration.md
doc/md/Server-security.md [deleted file]
doc/md/Shaarli-configuration.md
doc/md/Sharing-content.md [deleted file]
doc/md/Static-analysis.md [deleted file]
doc/md/Troubleshooting.md
doc/md/Unit-tests.md [deleted file]
doc/md/Upgrade-and-migration.md
doc/md/Usage.md [new file with mode: 0644]
doc/md/dev/Development.md [new file with mode: 0644]
doc/md/dev/GnuPG-signature.md [moved from doc/md/GnuPG-signature.md with 66% similarity]
doc/md/dev/Plugin-system.md [moved from doc/md/Plugin-System.md with 96% similarity]
doc/md/dev/Release-Shaarli.md [new file with mode: 0644]
doc/md/dev/Theming.md [moved from doc/md/Theming.md with 99% similarity]
doc/md/dev/Translations.md [moved from doc/md/Translations.md with 66% similarity]
doc/md/dev/Unit-tests.md [new file with mode: 0644]
doc/md/dev/Versioning.md [moved from doc/md/Versioning-and-Branches.md with 58% similarity]
doc/md/dev/images/poedit-1.jpg [moved from doc/md/images/poedit-1.jpg with 100% similarity]
doc/md/docker/docker-101.md [deleted file]
doc/md/docker/resources.md [deleted file]
doc/md/docker/reverse-proxy-configuration.md [deleted file]
doc/md/docker/shaarli-images.md [deleted file]
doc/md/guides/backup-restore-import-export.md [deleted file]
doc/md/guides/images/01-create-droplet-distro.jpg [deleted file]
doc/md/guides/images/02-create-droplet-region.jpg [deleted file]
doc/md/guides/images/03-create-droplet-size.jpg [deleted file]
doc/md/guides/images/04-finalize.jpg [deleted file]
doc/md/guides/images/05-droplet.jpg [deleted file]
doc/md/guides/images/06-domain.jpg [deleted file]
doc/md/guides/install-shaarli-with-debian9-and-docker.md [deleted file]
doc/md/guides/various-hacks.md [deleted file]
doc/md/images/07-installation.jpg [moved from doc/md/guides/images/07-installation.jpg with 100% similarity]
doc/md/images/bookmarklet.png [deleted file]
doc/md/images/firefoxshare.png [deleted file]
doc/md/images/install-shaarli.png [deleted file]
doc/md/index.md
mkdocs.yml
plugins/playvideos/README.md