Commit graph

192 commits

Author SHA1 Message Date
nodiscc 02c70f624e doc: fix homepage icon
The icon did not display properly on https://shaarli.readthedocs.io/en/master/
2019-01-06 02:10:04 +01:00
nodiscc 7062ef4ddd
doc: update PHP compatibility table
Ref https://github.com/shaarli/Shaarli/issues/1249
2018-12-09 14:40:04 +00:00
Alexandre G.-Raymond 6fd287a0a2
Dead link on dead link detector tool
Author's repo moved to Framagit
2018-10-20 11:58:49 +02:00
nodiscc d3734b0652
Merge pull request #1232 from shaarli/doc-rm-firefox-share
remove firefox share documentation
2018-10-11 10:03:48 +00:00
nodiscc afe4377e4d
Merge pull request #1221 from nodiscc/doc-refactor-index-features2
doc: refactor documentation homepage
2018-10-11 08:09:45 +00:00
nodiscc 37bbfb5f65 remove firefox share documentation
Firefox Share integration has been removed in https://github.com/shaarli/Shaarli/pull/1026
Firefox Share is not available anymore in any ESR/release versions of Firefox
2018-10-11 09:51:14 +02:00
nodiscc 8b2afee16b Revert part of #1220
Fixes #1177
The `url` template filter is [only supported in Mkdocs 1.0+](https://github.com/mkdocs/mkdocs/blob/master/docs/about/release-notes.md#internal-refactor-of-pages-files-and-navigation)
Readthedocs.org uses Mkdocs `0.17.3 ` while `make htmldoc` fetches the [latest version from pypi](https://pypi.org/project/mkdocs/) which is `1.0.4`.
Following https://github.com/shaarli/Shaarli/pull/1220, building the docs fails with https://readthedocs.org/projects/shaarli/builds/7886340/
2018-10-09 19:35:56 +02:00
nodiscc 6c44d604a1 doc: server config: basic usage of robots.txt/HTML robots meta-tag/crawler control mechanisms 2018-09-09 16:21:58 +02:00
nodiscc 2b4f391559 add "noindex, nofollow" HTML robots meta-tag to documentation pages
- 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
2018-09-09 16:21:03 +02:00
nodiscc b817fb0d95 documentation: refactor documentation homepage
- simplify/organize feature list and contributing section
- move bug reporting/contact information to Contributing section
- unclutter

Ref https://github.com/shaarli/Shaarli/issues/1148#issuecomment-397871451 and https://github.com/shaarli/Shaarli/issues/598
2018-08-30 21:09:02 +02:00
ArthurHoaro ad5f47adba
Merge pull request #687 from ArthurHoaro/web-thumb
Use web-thumbnailer to retrieve thumbnails
2018-07-28 09:41:29 +02:00
Aurélien Tamisier 8fdd65b884
Merge pull request #1168 from virtualtam/docker/compose
Provide a Docker Compose example
2018-07-27 19:25:52 +02:00
ArthurHoaro 40f0ff2236 Documentation - REST API - Mention dev.debug mode 2018-07-17 13:54:15 +02:00
VirtualTam a0c34a4976 Docs: Add an installation guide for Debian 9 + Docker
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-07-12 22:50:30 +02:00
nodiscc 9cc6ea6560
Merge pull request #1178 from pips-/patch-2
Upgrade-and-migration.md: typo installation link
2018-07-12 22:01:21 +02:00
VirtualTam 1cafacfedd Docs: rename 'How-to' section to 'Guides'
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-07-12 21:48:48 +02:00
pips f39b1242a8
Upgrade-and-migration.md: install link typo
second one
2018-07-10 00:38:59 +02:00
pips 3028a84c13
Upgrade-and-migration.md: typo installation link
Install page is not correctly linked
2018-07-10 00:29:24 +02:00
nodiscc 5045585f24
doc: reverse proxy config: proxypreservehost: wording, link to apache documentation, typo 2018-07-08 19:54:48 +02:00
ArthurHoaro e7f4a03d24 Include ProxyPreserveHost directive in Apache's proxy doc 2018-07-05 21:13:09 +02:00
ArthurHoaro 787faa42f3 Take code review into account
Upgrade web-thumbnailer and display thumbs right after download
2018-07-05 20:34:22 +02:00
ArthurHoaro 8b5b7dcc83 Add Link structure page to the documentation 2018-07-05 20:31:35 +02:00
VirtualTam 186d9eaa57 Docker: expose a volume for the thumbnail cache
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-07-05 18:17:07 +02:00
VirtualTam 87f1431247 Fix broken documentation links and list formatting
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-06-26 22:22:33 +02:00
VirtualTam 52731281bc
Merge branch 'master' into patch-1 2018-06-26 21:47:27 +02:00
Felix Bartels 359696dcbb
add Cloudron to related software 2018-06-25 10:05:04 +02:00
lapineige de15ed1def
Other platform integration: add Yunohost install badge
Add a button to install with Yunohost in a one-click way.
2018-06-25 09:28:29 +02:00
nodiscc 969ed87fb1
Merge pull request #1155 from shaarli/doc-improvements
Improve documentation (#598, #1105)
2018-06-21 19:34:11 +02:00
VirtualTam 7519388dd6
Merge pull request #1154 from virtualtam/changelog
Update AUTHORS and CHANGELOG
2018-06-20 17:18:47 +02:00
VirtualTam 6e1df6013e Update version badges and installation instructions
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-06-20 17:14:30 +02:00
nodiscc bdfb967ca2 Improve documentation (#598, #1105)
* 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
2018-06-17 18:56:00 +02:00
VirtualTam c064d3179e docker: update image and usage documentation
Relates to https://github.com/shaarli/Shaarli/issues/1153

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-06-17 13:45:39 +02:00
ArthurHoaro 4de024d7c3 Adds Stakali Android app to 3rd party lists 2018-05-13 12:35:30 +02:00
nodiscc 2e47af897e doc: sharing: add link to REST API documentation 2018-04-14 14:15:00 +02:00
nodiscc 630790a1aa doc: optimize PNGs with pngcrush
164k -> 156k
2018-04-14 14:15:00 +02:00
nodiscc bf7993dceb doc: add edit_icon.png to git repository
optimize icon with optipng/pngcrush (3.30%)
2018-04-14 14:15:00 +02:00
nodiscc 80786e150d doc: merge all sharing methods under a single "Sharing content" page
* 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
2018-04-14 14:14:59 +02:00
VirtualTam d66b5acb24 Update documentation and Doxygen icon location
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-04-05 20:54:23 +02:00
ArthurHoaro d7eb06bd7c Webpack / Documentation update 2018-03-28 19:04:40 +02:00
ArthurHoaro 9b2bd66fb6
Merge pull request #1093 from ArthurHoaro/feature/theme-translation
Load theme translations files automatically
2018-03-26 20:26:10 +02:00
ArthurHoaro 68c6afc56f Load theme translations files automatically
Fixes #1077

Take a look at the docs update to see how it works
2018-03-26 19:20:25 +02:00
VirtualTam ee242ae321 Documentation: release v0.9.6
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-03-25 20:11:10 +02:00
Alexandre G.-Raymond 6c4cc14e00
Fix current version file name in docs 2018-03-25 14:08:07 +02:00
VirtualTam 48679a159e doc: update references to config(.json)?.php
Closes https://github.com/shaarli/Shaarli/issues/1082

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-02-14 22:02:50 +01:00
VirtualTam 4c1bcd8b25 doc: update Directory Structure
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-02-14 21:58:41 +01:00
nodiscc 5f8c3f532e
Merge pull request #1058 from FranckKe/patch-1
doc: bookmarklet: fix link to issue 196
2018-01-18 20:49:29 +01:00
nodiscc bc55e94795
Merge pull request #1057 from shaarli/doc-derefind
doc: import: add link to derefind conversion tool
2018-01-18 20:49:20 +01:00
nodiscc 26c5b1bca6
Merge pull request #1049 from shaarli/doc-docker-arm
doc: add arm32v7 docker build documentation
2018-01-18 20:48:46 +01:00
Franck Kerbiriou dafb386524
Fix link to issue 196 2018-01-18 14:10:48 +01:00
nodiscc a52d39dafb
doc: import: add link to derefind conversion tool
As mentioned on gitter
2018-01-17 21:47:13 +01:00
nodiscc 5cb4c0d5bd
doc: fix link to dockerfiles 2018-01-13 11:48:42 +01:00
nodiscc a3f83c15f4
doc: docker: add links to docker build and qemu documentation 2018-01-12 23:06:30 +01:00
nodiscc bf4faba9ca
doc: docker: remove armhf tags, add link to Dockerfiles 2018-01-12 23:00:20 +01:00
nodiscc 42884868a3
doc: Server Requirements: php-mbstring: add 'hosting providers' 2018-01-09 20:13:05 +01:00
ArthurHoaro c8f7ba36ce
Merge pull request #1043 from immanuelfodor/improvement/shaarli-markdown-toolbar
Adding 3rd party plugin 'markdown-toolbar' to docs
2018-01-06 11:27:53 +01:00
nodiscc b7ca2eb2f6 doc: add armhf docker images 2018-01-05 19:41:24 +01:00
VirtualTam f452d3c4df Update CHANGELOG, README badges and installation instructions
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-01-04 18:49:05 +01:00
ArthurHoaro 12db590e8f
Merge pull request #1042 from immanuelfodor/improvement/shaarli-descriptor
Adding 3rd party plugin 'shaarli-descriptor' to docs
2018-01-01 14:31:20 +01:00
immanuelfodor 310e36d19c adding 3rd party plugin markdown-toolbar to docs 2017-12-30 13:45:08 +01:00
immanuelfodor 36fa51d996
modifying plugin description to be easy to understand 2017-12-27 17:01:08 +01:00
immanuelfodor 0ecfca3b9d
adding 3rd party plugin shaarli-descriptor to docs 2017-12-27 08:47:15 +01:00
nodiscc 31cefb9ac1
fix heading level 2017-12-26 18:41:38 +01:00
nodiscc ebee8d9372
Update Community-&-Related-software.md
reorganize sections
2017-12-26 18:39:27 +01:00
nodiscc 5faa0697dd Merge remote-tracking branch 'nerostie/patch-2' into doc-overhaul 2017-12-17 23:43:03 +01:00
nodiscc 236a8e48b6 minor fixes, ref #998 2017-12-17 23:41:03 +01:00
nodiscc 286757ab29 Merge remote-tracking branch 'origin/doc-tagcloud' into doc-overhaul 2017-12-17 23:39:20 +01:00
Neros f6f8b2563c
New plugin: Twemoji 2017-12-17 19:34:15 +01:00
nodiscc ebc7ec7c1c
doc: remove docker autobuild doc from index.md 2017-12-09 15:34:06 +01:00
nodiscc 60ca6354bd
doc: move docker autobuild from index.md to shaarli-images.md 2017-12-09 15:33:49 +01:00
nodiscc 32488257ee
move docker-101 reference from index.md to docker-images.md 2017-12-09 15:31:45 +01:00
nodiscc 7a205fb21c
doc: fix docker documentation link 2017-12-09 15:28:34 +01:00
nodiscc ceb3f9174b
Delete Features.md 2017-12-09 15:20:30 +01:00
nodiscc 4ada0d313a
move features.md info to index.md
Ref https://github.com/shaarli/Shaarli/issues/598
2017-12-09 15:20:14 +01:00
nodiscc 2887879173
doc: add browser addons/shaarli-web-extension
cleanup shaarliOs link
shorten awesome-selfhosted entry
2017-12-09 15:11:57 +01:00
nodiscc d0b8ffb952
doc: note about firefox share compatibility 2017-12-09 15:04:44 +01:00
durcheinandr 03809dbb4d Fix internal markdown link in documentation 2017-12-07 13:25:13 +01:00
nodiscc 76c3a4dbed documentation cleanup
* In preparation of #930 work
 * Remove/reorder duplicate documentation from Makefile/Unit-tests.md/Download-and-Installation.md (composer information is now in Unit-tests.md)
 * Installation using git: add composer requirement to all git installation procedures, add python3-virtualenv requirement
 * Styling (horizontal rulers, spacing, descriptive headers)
2017-11-18 16:22:43 +01:00
kalvn f8623666aa
Addition of shaarli2mastodon plugin. 2017-11-01 18:36:11 +01:00
VirtualTam e648f62b4f Merge pull request #1004 from virtualtam/doc/docker/reverse-proxy
Documentation: add reverse proxy examples for Docker images
2017-10-22 17:07:45 +02:00
VirtualTam 1a2c5ddeb5 Documentation: add reverse proxy examples for Docker images
Closes https://github.com/shaarli/Shaarli/issues/888

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-10-22 15:03:20 +02:00
ArthurHoaro 2e6314af31 Merge pull request #1002 from ArthurHoaro/doc/install-docker
Docs: mention Docker in the download & install page
2017-10-22 14:56:26 +02:00
ArthurHoaro d8acf85504 Merge pull request #871 from ArthurHoaro/feature/translation
Shaarli's translation
2017-10-22 13:19:51 +02:00
ArthurHoaro 1a47014f99 Translation documentation 2017-10-22 13:16:59 +02:00
ArthurHoaro cfcc38192a Doc: mention Docker docs in the download & install page 2017-10-22 12:50:04 +02:00
VirtualTam fab0f4e576 docker: add 'latest' image
This implies the following changes:
- `shaarli/shaarli:latest` will now point to the `latest` release
- `shaarli/shaarli:master` will point to the `master` branch

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-10-21 18:44:19 +02:00
nodiscc 919c980344 documentation: update tag cloud/filtering doc
Ref. https://github.com/shaarli/Shaarli/issues/959
2017-10-19 18:06:07 +02:00
Daniel Jakots ba6245670d Fix link in Upgrade-and-migration.md 2017-10-07 09:35:40 -04:00
VirtualTam f5bdd8edc8 Merge pull request #983 from bvberkum/pullrequest/shaarli-docker-quickstart
Docker quickstart
2017-10-06 14:30:18 +02:00
B. van Berkum df8becac4f Minor docker-101 doc updates, typos fixed #983 2017-10-06 00:25:50 +02:00
B. van Berkum 2f65b3dd53 Docker quickstart: one more grammar mistake. Made it a bit more terse. 2017-10-03 01:03:27 +02:00
B. van Berkum 62a8b0ff6e Docker-101: added working systemd config example 2017-10-03 00:57:46 +02:00
B. van Berkum 60ed9b8f41 Typo's, unified structure a bit.
- Fixes inevitable typo that crept in.
- Removed some blank lines, newlines, to match established whitespace use better.
- Minor grammar improvement.
2017-10-03 00:35:27 +02:00
B. van Berkum 22a30602cb Docker 101: container start and cleanup 2017-10-03 00:24:23 +02:00
B. van Berkum 02ff7897c0 Added docker quickstart example, with user-data volume 2017-10-03 00:23:34 +02:00
Mark Gerarts 722caa2090 Allow setting of a default note title, see #963 2017-10-01 14:19:57 +02:00
VirtualTam 6aae4bd0a1 Merge pull request #909 from virtualtam/docker/test-environments
docker: add alpine,debian,ubuntu test images
2017-09-19 18:18:35 +02:00
VirtualTam d691604080 docker: add alpine,debian,ubuntu test images
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>
2017-09-18 21:13:59 +02:00
Willi Eggeling 27e21231e1 added option to redirect all anonymous users to login page
- new setting *force_login* added and documented
- if both, *force_login* and *hide_public_links* are set to true, all requests
  (except for the feeds) are redirected to the login page
2017-09-03 11:46:49 +02:00
VirtualTam dc37a482ed Documentation+Makefile: update AUTHORS generation
Fixes https://github.com/shaarli/Shaarli/issues/935

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-29 19:46:23 +02:00
VirtualTam e4ed3a46b7 Merge pull request #944 from thewilli/configure-rememberme
new setting: default value for 'remember me' checkbox
2017-08-27 16:36:53 +02:00