aboutsummaryrefslogtreecommitdiffhomepage
path: root/mkdocs.yml
Commit message (Collapse)AuthorAgeFilesLines
* **General rewording, proof-reading, deduplication, shortening, reordering, ↵nodiscc2020-09-121-31/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: merge unit tests/docker unit tests pages, simplfy, rewordnodiscc2020-01-191-1/+0
|
* add "noindex, nofollow" HTML robots meta-tag to documentation pagesnodiscc2018-09-091-1/+3
| | | | | | - Customize the "readthedocs" mkdocs theme: https://www.mkdocs.org/user-guide/styling-your-docs/#customizing-a-theme - Adds a '<meta name="robots" content="noindex, nofollow">' HTML tag on each page - Do not include robots directive on readthedocs.org, only in local builds
* Merge pull request #687 from ArthurHoaro/web-thumbArthurHoaro2018-07-281-0/+1
|\ | | | | Use web-thumbnailer to retrieve thumbnails
| * Add Link structure page to the documentationArthurHoaro2018-07-051-0/+1
| |
* | Merge pull request #1168 from virtualtam/docker/composeAurélien Tamisier2018-07-271-3/+4
|\ \ | | | | | | Provide a Docker Compose example
| * | Docs: Add an installation guide for Debian 9 + DockerVirtualTam2018-07-121-0/+1
| | | | | | | | | | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
| * | Docs: rename 'How-to' section to 'Guides'VirtualTam2018-07-121-3/+3
| |/ | | | | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* / Disable MkDocs' strict mode for ReadTheDocs builds to passVirtualTam2018-07-241-1/+4
|/ | | | | | | | | | Relates to https://github.com/shaarli/Shaarli/issues/1179 See: - https://www.mkdocs.org/user-guide/configuration/#build-directories - https://github.com/rtfd/readthedocs.org/issues/4314 Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Run MkDocs in strict modeVirtualTam2018-06-261-1/+2
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Improve documentation (#598, #1105)nodiscc2018-06-171-1/+0
| | | | | | | | | | | | | | | | * rework/simplify server configuration/requirements pages (consolidate/simplify SSL/TLS/apache configuration) * update index.md introduction * remove external images (badges) * Fix COPYING link and documentation links * Update features list * dedpulicate information * remove server-requirements.md and move relevant doc to other files * TODO: rework nginx configuration (single configuration example, with commented out blocks for special cases) * TODO: consolidate download/install/configuration pages * remove blank lighttpd configuration section * remove Required? column for composer packages, all libraries are mandatory * php 7.2 compatibilty * clarify that certbot binary and paths may vary depending on install method
* doc: merge all sharing methods under a single "Sharing content" pagenodiscc2018-04-141-2/+1
| | | | | | | | | * formatting, wording, reordering, general improvements * move blog/pastebin/notepad item from index.md to this page * add TODOs * add the new page to mkdocs TOC Part of https://github.com/shaarli/Shaarli/issues/598
* mkdocs.yml: move FAQ to top level, reorder, Move Community/related software ↵nodiscc2017-12-261-4/+3
| | | | to Usage
* remove Features.md entry in mkdocs.ymlnodiscc2017-12-091-1/+0
|
* Translation documentationArthurHoaro2017-10-221-0/+1
|
* docker: add alpine,debian,ubuntu test imagesVirtualTam2017-09-181-0/+1
| | | | | | | | | | | | | | | Relates to https://github.com/shaarli/Shaarli/issues/843 Added: - Makefile target to run commands in a Docker test context - Docker images to run Shaarli test suites: - Alpine 3.6 - Debian 8 - Debian 9 - Ubuntu 16.04 - Documentation Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: remove duplicate "Coding guidelines" pageVirtualTam2017-08-051-1/+0
| | | | | | The information is already present under "Static analysis" Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: set edit_uriVirtualTam2017-08-021-0/+1
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* docker: remove `dev` image, update documentationVirtualTam2017-07-291-4/+4
| | | | | | | | | | | | | | Relates to https://github.com/shaarli/Shaarli/issues/843 Changed: - Update Docker image list - Update Docker documentation structure Removed: - Delete Dockerfile and resources for the `dev` image - Cleanup `doc/` resources Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* doc: rename "datastore hacks" -> "various hacks", move example scripts to ↵nodiscc2017-06-181-4/+1
| | | | gist.github.com, remove obsolete GH wiki _Sidebar.md
* Generate HTML documentation using MkDocs (WIP)nodiscc2017-06-181-0/+53
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-28 21:06:30 +0000