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
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
4de024d7c3
Adds Stakali Android app to 3rd party lists
2018-05-13 12:35:30 +02:00
2e47af897e
doc: sharing: add link to REST API documentation
2018-04-14 14:15:00 +02:00
630790a1aa
doc: optimize PNGs with pngcrush
...
164k -> 156k
2018-04-14 14:15:00 +02:00
bf7993dceb
doc: add edit_icon.png to git repository
...
optimize icon with optipng/pngcrush (3.30%)
2018-04-14 14:15:00 +02:00
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
d66b5acb24
Update documentation and Doxygen icon location
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-04-05 20:54:23 +02:00
d7eb06bd7c
Webpack / Documentation update
2018-03-28 19:04:40 +02:00
9b2bd66fb6
Merge pull request #1093 from ArthurHoaro/feature/theme-translation
...
Load theme translations files automatically
2018-03-26 20:26:10 +02:00
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
ee242ae321
Documentation: release v0.9.6
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-03-25 20:11:10 +02:00
6c4cc14e00
Fix current version file name in docs
2018-03-25 14:08:07 +02:00
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
4c1bcd8b25
doc: update Directory Structure
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-02-14 21:58:41 +01:00
d923d1db2f
Merge remote-tracking branch 'github/latest' into myShaarli_commu
2018-02-09 16:10:09 +01:00
5f8c3f532e
Merge pull request #1058 from FranckKe/patch-1
...
doc: bookmarklet: fix link to issue 196
2018-01-18 20:49:29 +01:00
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
26c5b1bca6
Merge pull request #1049 from shaarli/doc-docker-arm
...
doc: add arm32v7 docker build documentation
2018-01-18 20:48:46 +01:00
dafb386524
Fix link to issue 196
2018-01-18 14:10:48 +01:00
a52d39dafb
doc: import: add link to derefind conversion tool
...
As mentioned on gitter
2018-01-17 21:47:13 +01:00
5cb4c0d5bd
doc: fix link to dockerfiles
2018-01-13 11:48:42 +01:00
a3f83c15f4
doc: docker: add links to docker build and qemu documentation
2018-01-12 23:06:30 +01:00
bf4faba9ca
doc: docker: remove armhf tags, add link to Dockerfiles
2018-01-12 23:00:20 +01:00
42884868a3
doc: Server Requirements: php-mbstring: add 'hosting providers'
2018-01-09 20:13:05 +01:00
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
b7ca2eb2f6
doc: add armhf docker images
2018-01-05 19:41:24 +01:00
f452d3c4df
Update CHANGELOG, README badges and installation instructions
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-01-04 18:49:05 +01:00
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
310e36d19c
adding 3rd party plugin markdown-toolbar to docs
2017-12-30 13:45:08 +01:00
36fa51d996
modifying plugin description to be easy to understand
2017-12-27 17:01:08 +01:00
0ecfca3b9d
adding 3rd party plugin shaarli-descriptor to docs
2017-12-27 08:47:15 +01:00
31cefb9ac1
fix heading level
2017-12-26 18:41:38 +01:00
ebee8d9372
Update Community-&-Related-software.md
...
reorganize sections
2017-12-26 18:39:27 +01:00
5faa0697dd
Merge remote-tracking branch 'nerostie/patch-2' into doc-overhaul
2017-12-17 23:43:03 +01:00
236a8e48b6
minor fixes, ref #998
2017-12-17 23:41:03 +01:00
286757ab29
Merge remote-tracking branch 'origin/doc-tagcloud' into doc-overhaul
2017-12-17 23:39:20 +01:00
f6f8b2563c
New plugin: Twemoji
2017-12-17 19:34:15 +01:00
22ee4c71a3
Merge branch 'master' of https://github.com/shaarli/Shaarli into myShaarli_commu
2017-12-15 10:04:41 +01:00
ebc7ec7c1c
doc: remove docker autobuild doc from index.md
2017-12-09 15:34:06 +01:00
60ca6354bd
doc: move docker autobuild from index.md to shaarli-images.md
2017-12-09 15:33:49 +01:00
32488257ee
move docker-101 reference from index.md to docker-images.md
2017-12-09 15:31:45 +01:00
7a205fb21c
doc: fix docker documentation link
2017-12-09 15:28:34 +01:00
ceb3f9174b
Delete Features.md
2017-12-09 15:20:30 +01:00
4ada0d313a
move features.md info to index.md
...
Ref https://github.com/shaarli/Shaarli/issues/598
2017-12-09 15:20:14 +01:00
2887879173
doc: add browser addons/shaarli-web-extension
...
cleanup shaarliOs link
shorten awesome-selfhosted entry
2017-12-09 15:11:57 +01:00
d0b8ffb952
doc: note about firefox share compatibility
2017-12-09 15:04:44 +01:00
03809dbb4d
Fix internal markdown link in documentation
2017-12-07 13:25:13 +01:00
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
8732a436eb
Merge remote-tracking branch 'commu/latest' into myShaarli_commu
2017-11-03 16:24:12 +01:00
f8623666aa
Addition of shaarli2mastodon plugin.
2017-11-01 18:36:11 +01:00
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
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
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
d8acf85504
Merge pull request #871 from ArthurHoaro/feature/translation
...
Shaarli's translation
2017-10-22 13:19:51 +02:00
1a47014f99
Translation documentation
2017-10-22 13:16:59 +02:00
cfcc38192a
Doc: mention Docker docs in the download & install page
2017-10-22 12:50:04 +02:00
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
919c980344
documentation: update tag cloud/filtering doc
...
Ref. https://github.com/shaarli/Shaarli/issues/959
2017-10-19 18:06:07 +02:00
ba6245670d
Fix link in Upgrade-and-migration.md
2017-10-07 09:35:40 -04:00
f5bdd8edc8
Merge pull request #983 from bvberkum/pullrequest/shaarli-docker-quickstart
...
Docker quickstart
2017-10-06 14:30:18 +02:00
df8becac4f
Minor docker-101 doc updates, typos fixed #983
2017-10-06 00:25:50 +02:00
2f65b3dd53
Docker quickstart: one more grammar mistake. Made it a bit more terse.
2017-10-03 01:03:27 +02:00
62a8b0ff6e
Docker-101: added working systemd config example
2017-10-03 00:57:46 +02:00
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
22a30602cb
Docker 101: container start and cleanup
2017-10-03 00:24:23 +02:00
02ff7897c0
Added docker quickstart example, with user-data volume
2017-10-03 00:23:34 +02:00
722caa2090
Allow setting of a default note title, see #963
2017-10-01 14:19:57 +02:00
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
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
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
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
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
2e07e77573
new setting: default value for 'remember me' checkbox
...
- the default state for the login page's 'remember me' checkbox can now be configured
- adapted the default and vintage theme to consider the new setting
- added documentation for the new setting
2017-08-27 16:03:37 +02:00
e8cef3ac43
Merge pull request #942 from thewilli/fix-wiki-links
...
migrated Github wiki links to readthedocs
2017-08-27 13:12:58 +02:00
94c035ff71
removed doc and code references to magic quotes
...
- removed all references to magic quotes
- magic quotes are not supported on PHP >= 5.4 (https://secure.php.net/manual/en/security.magicquotes.php )
- Shaarli does not support PHP < 5.5
2017-08-26 11:27:18 +02:00
cc8f572bc0
migrated Github wiki links to readthedocs
2017-08-26 09:40:57 +02:00
d3fee4f40b
documentation: update installation instructions for 0.9.1
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-23 01:22:07 +02:00
92ccaea470
documentation: fix list formatting
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-23 00:57:50 +02:00
57c628e195
documentation: update 3rd-party resources
...
Relates to https://github.com/shaarli/Shaarli/issues/915
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-08 22:02:50 +02:00
f320efd689
documentation: elaborate on REST API server & client prerequisites
...
Relates to https://github.com/shaarli/Shaarli/issues/903
Relates to https://github.com/shaarli/Shaarli/issues/905
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:46:05 +02:00
23daed648c
documentation: remove obsolete doc release instructions
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:33:07 +02:00
61f63d1086
documentation: add links to example REST API clients
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:30:43 +02:00
e62486dd6a
documentation: rewrite the REST API PHP client example
...
Closes https://github.com/shaarli/Shaarli/issues/905
Relates to https://github.com/shaarli/Shaarli/pull/751
See https://shaarli.github.io/api-documentation/
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:15:59 +02:00
7f876cf62b
documentation: update release download and usage information
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 12:08:09 +02:00
28439d63b8
documentation: remove duplicate "Coding guidelines" page
...
The information is already present under "Static analysis"
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 12:05:15 +02:00
43ad7c8e82
documentation: fix rendering and internal references
...
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.
Changed:
- rephrase some section titles
Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links
Removed:
- extraneous navigational elements
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 11:56:24 +02:00
fcd900f7ce
documentation: remove uneeded resources
...
Relates to https://github.com/shaarli/Shaarli/issues/312
Relates to https://github.com/shaarli/Shaarli/pull/772
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-02 14:48:41 +02:00
9ff77362fe
documentation: remove generated HTML from SCM
...
Relates to https://github.com/shaarli/Shaarli/issues/908
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-02 14:48:41 +02:00
3a6f91a9cc
Generate HTML documentation
...
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-07-29 15:33:35 +02:00
84d0632a2d
docker: remove `dev` image, update documentation
...
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>
2017-07-29 15:32:22 +02:00
6d074b4c90
doc: fix bullet list formatting
...
https://shaarli.readthedocs.io/en/master/Shaarli-configuration/
2017-07-20 19:52:39 +02:00
366247c84c
make htmlpages
2017-07-04 21:30:31 +02:00
2f9c1ecf88
doc: release: update doc generation instructions
2017-07-04 21:26:01 +02:00
081a73486f
doc: replace pandoc requirement with python3-venv
2017-06-18 22:22:34 +02:00
12e1877917
move README contents to doc/md/index.md
2017-06-18 22:15:50 +02:00
0433c688b9
make htmlpages
2017-06-18 06:32:30 +02:00
460ce50115
doc: rename "datastore hacks" -> "various hacks", move example scripts to gist.github.com, remove obsolete GH wiki _Sidebar.md
2017-06-18 06:29:15 +02:00
53ed6d7d1e
Generate HTML documentation using MkDocs (WIP)
...
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
2017-06-18 00:19:49 +02:00
b230bf207d
Bump version to v0.9.0
...
Signed-off-by: ArthurHoaro <arthur@hoa.ro>
2017-05-07 18:44:05 +02:00
nodiscc
VirtualTam
ArthurHoaro
Alexandre G.-Raymond
Knah Tsaeb
Franck Kerbiriou
immanuelfodor
Neros
durcheinandr
kalvn
VirtualTam
Daniel Jakots
B. van Berkum
Mark Gerarts
Willi Eggeling
Willi Eggeling