Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
2402 commits 8 branches 1 tag 12 MiB
Commit graph

322 commits

Author SHA1 Message Date
nodiscc
0992c86f16
doc: add missing h1 heading to Usage.md 2023-10-05 15:01:42 +02:00
nodiscc
256cffb289
doc: fix typo 2023-10-05 15:01:42 +02:00
nodiscc
62552cc413
doc: development: standardize hooks documentation, use less headings 2023-10-05 15:01:42 +02:00
nodiscc
a4b3430078
doc: fix link to translations documentation 2023-10-05 15:01:42 +02:00
nodiscc
5dd9bc93e1
doc: fix syntax highlighting in code blocks 
- remove json syntax highlighting from invalid json block
- fix warning about unknown lexer `conf`
- fix syntax highlighting for example htaccess
 2023-10-05 15:01:42 +02:00
nodiscc
9230af464d
doc: group all development-releated documentation under a single Development page 
- add the Development page to the main TOC
 2023-10-05 15:01:42 +02:00
nodiscc
b7719cdf0a
doc: plugin system: fix links to anchors 2023-10-05 15:01:41 +02:00
nodiscc
db1532214e
replace mkdocs with sphinx/myst-parser for HTML documentation generation 
- fixes https://github.com/shaarli/Shaarli/issues/1451
- tools/.gitattributes: exclude doc/conf.py and doc/requirements.txt from zip exports
- tools/doc/sphinx: suppress myst.xref_missing warnings caused by https://github.com/executablebooks/MyST-Parser/issues/564
- dockerfile: use makefile/sphinx instead of mkdocs to build HTML documentation
- dockerfile: add bash to the docs build container (make: bash: No such file or directory)
- tools/doc/readthedocs: force use of python 3.11 (readthedocs ERROR: No matching distribution found for sphinx==7.1.0)
- tools/doc/readthedocs: add all required configuration variables https://docs.readthedocs.io/en/latest/config-file/v2.html#build-os
- tools/doc/readthedocs: override build commands to allow the source directory to be different from the conf.py directory (https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands, https://github.com/readthedocs/readthedocs.org/issues/1543)
- tools/doc/readthedocs: manually set output directory (readthedocs ERROR: No _readthedocs/html folder was created during this build.)
- doc: replace all references to mkdocs with sphinx
 2023-10-05 15:01:34 +02:00
nodiscc
ea3cda543c
Merge pull request #2021 from shaarli/doc-php8.2-compat 
doc: server configuration: add PHP 8.2 to PHP compatibility table
 2023-09-25 15:06:08 +00:00
nodiscc
280e6138fc
Merge pull request #2003 from nodiscc/doc-hyphens 
correct usage of hyphens in all occurences of 'super fast, database-free'
 2023-09-25 14:57:55 +00:00
nodiscc
4b94854200
doc: server configuration: add PHP 8.2 to PHP compatibility table 
- Tested with php-fpm 8.2.7-1~deb12u1 on Debian 12
- ref. https://github.com/shaarli/Shaarli/issues/2020
 2023-09-21 12:48:23 +00:00
nodiscc
25d2a9b744
doc: community/related software/integration with other platforms: add link to shaarli debian package 
- fixes https://github.com/shaarli/shaarli-pkg-debian/issues/8
- https://github.com/shaarli/shaarli-pkg-debian is unmaintained, please use downstream packaging repo at https://salsa.debian.org/php-team/pear/shaarli
- https://github.com/shaarli/shaarli-pkg-debian will be archived after this PR is merged
 2023-08-27 15:59:39 +02:00
nodiscc
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
 2023-08-20 23:13:59 +02:00
nodiscc
910b695d4d
correct usage of hyphens in all occurences of 'super fast, database-free' 
- fixes https://github.com/shaarli/Shaarli/issues/1758
 2023-07-06 18:57:22 +02:00
nodiscc
27db81ab07
Merge pull request #1987 from nodiscc/doc-or-operator 
doc: improve docs on usage of OR operator in tags search
 2023-05-21 18:30:57 +00:00
nodiscc
a1c6460077
doc: improve docs on usage of OR operator in tags search 
- fixes https://github.com/shaarli/Shaarli/issues/1982
 2023-05-21 20:27:12 +02:00
Nicolas Le Gaillart
eb340c7eb6
Update Community-and-related-software.md 
Hi, here are my two little plugins for Shaarli.
 2023-05-17 22:33:36 +02:00
Gregory
5f69e17310
Update Server-configuration.md (#1973) 2023-04-15 09:02:48 -04:00
nodiscc
08d9347e9a
Merge pull request #1958 from ArthurHoaro/php-drop-7.3-and-less 
Drop support for PHP 7.1, 7.2 and 7.3
 2023-04-03 15:43:07 +00:00
ArthurHoaro
050bb50cdf
Update compatibility matrix 2023-03-25 09:42:42 -04:00
nodiscc
062698c123
doc: update release procedure (merge the latest release to the release branch) 
- ref. https://github.com/shaarli/Shaarli/pull/1959
 2023-03-20 18:08:02 +01:00
ArthurHoaro
6624f00c05
Makefile: Use GNU tar if available (#1957) 2023-03-18 14:03:34 -04:00
ArthurHoaro
ebe9417981
Rename authors makefile target to avoid conflicts with filename (#1955) 2023-03-18 13:19:37 -04:00
nodiscc
721c090198
doc: move OCI images hosting to ghcr.io 
- dockerhub free team accounts will be deleted in < 30 days (https://www.docker.com/blog/we-apologize-we-did-a-terrible-job-announcing-the-end-of-docker-free-teams/), this affects the Shaarli team account
- automated builds will keep pushing latest builds to dockerhub in addition to gchr.io, until the account is deleted
- **users relying on `shaarli/shaarli` OCI images are advised to migrate to `ghcr.io/shaarli/shaarli` as soon as possible**
- existing tagged images have been copied from https://hub.docker.com/r/shaarli/shaarli/ to https://github.com/shaarli/Shaarli/pkgs/container/shaarli/versions?filters%5Bversion_type%5D=tagged
- prepend `ghcr.io/` to all references to OCI images
- update all references to dockerhub -> github packages registry, update developer documentation, cleanup dead links
- ref. https://github.com/shaarli/Shaarli/issues/1948
 2023-03-17 16:17:37 +01:00
Denis Renning
4c76d4eea9
Github actions: update node (#1928) 
* update Node dependent actions
* doc: update compatibility table

Co-authored-by: William Desportes <williamdes@wdes.fr>
Co-authored-by: nodiscc <nodiscc@gmail.com>
 2023-03-17 01:22:20 +00:00
nodiscc
a9acad9e1a
doc: troubleshooting: add note to adjust proxy timeouts or PHP max execution time if encountering timeouts 
- fixes https://github.com/shaarli/Shaarli/issues/1910
- fixes https://github.com/shaarli/Shaarli/issues/1854
 2023-02-19 15:29:56 +01:00
nodiscc
de895c73b7
doc: shaarli configuration: mention file:/// URIs 
fixes https://github.com/shaarli/Shaarli/issues/1906
 2023-01-29 23:17:48 +00:00
Sebastien Wains
6d4e397805
Add mention to Shaarli Archiver (#1926) 2022-12-24 07:23:54 -05:00
nodiscc
bc470ef8c7
doc: PHP extensions are also required for development (#1922) 2022-12-24 07:21:11 -05:00
nodiscc
7bcf4255a7
doc: usage.md: add note about batch/bulk creation operation 
added in https://github.com/shaarli/Shaarli/pull/1587
 2022-12-04 13:02:07 +01:00
nodiscc
a54795f8eb
Merge pull request #1876 from ArthurHoaro/doc/apache-docs 
doc(apache2): allow access to local docs folder
 2022-10-14 15:52:37 +00:00
nodiscc
221a2534b2
Merge pull request #1858 from nodiscc/doc-thumbnailer-mode 
doc: shaarli configuration: fixes/improvements to thumbnails settings documentation
 2022-09-12 23:13:41 +00:00
nodiscc
8c4c408072
doc: shaarli configuration: update thumbnails-related configuration settings/examples 
- remove obsolete config keys
 2022-09-04 12:23:08 +02:00
ArthurHoaro
dc08e17996 doc(apache2): allow access to local docs folder 2022-08-20 10:46:53 +02:00
nodiscc
3665594d36
Merge pull request #1727 from ArthurHoaro/feature/readit 
New Core Plugin: ReadItLater
 2022-08-16 10:42:20 +02:00
ArthurHoaro
8a7a09df90
Merge pull request #1787 from yfdyh000/software.md 2022-08-13 16:12:59 +02:00
YFdyh000
10b460fbd2 refine Community-and-related-software.md and tools page 
- tpl/default/tools.html: simplify Third-party resources section
 - doc: community & related software: add AddToShaarli source code link
 - fix addtoshaarli source link
 - improve shields.io badges/formatting
 - use shields.io for cloudron/yunohost links
 - use a generic-looking icon

Worked on by @yfdyh000 and @nodiscc
 2022-08-13 10:25:52 +02:00
ArthurHoaro
22d43c303b
Merge pull request #1788 from yfdyh000/messages_210822 2022-08-13 10:11:21 +02:00
ArthurHoaro
8b10110c2b ArthurHoaro code review: typo 2022-08-13 10:07:21 +02:00
ArthurHoaro
39c89d84f5 Update official plugin list in the documentation 2022-08-12 19:58:07 +02:00
nodiscc
fdfc09f73f
tests: update base alpine image to v3.16 in test Dockerfiles 2022-08-10 20:15:21 +02:00
nodiscc
febe0a6487 doc: installation/tests: clarify build tools installation procedure 
- don't repeat link to getcomposer.org
- add an example of installing build dependencies on Debian
 2022-04-06 19:29:35 +02:00
nodiscc
7ae4b2f8b0
doc: add "formatter" key to example config.json.php 
- fixes https://github.com/shaarli/Shaarli/issues/1680
 2021-10-10 15:11:38 +02:00
nodiscc
df0ca43873
doc: remove duplicate "general" key in example config.php.json 
- ref. https://github.com/shaarli/Shaarli/issues/1680
 2021-10-10 15:09:57 +02:00
nodiscc
e0f4fd4537
doc: fix homepage title/icon rendering 
- fixes https://github.com/shaarli/Shaarli/issues/1774
 2021-09-26 21:53:41 +02:00
Keith Carangelo
a7d43caccb Added support for OR (~) and optional AND (+) operators for tag searches. 2021-09-08 15:26:58 -04:00
YFdyh000
dea58d5abd trivial refine for messages 2021-08-22 21:58:52 +08:00
ToM
63fe4881cc doc: remove the markdown plugin from the plugins list 
The plugin is now part of core since v0.12.0
 2021-08-01 16:44:31 +02:00
nodiscc
a79707258f
Merge pull request #1768 from nodiscc/doc-proxy-subdirectory 
doc: add notice about nginx location directive when shaarli is installed in a subdirectory
 2021-07-19 17:02:29 +00:00
nodiscc
1a36e314ba
Merge pull request #1769 from nodiscc/doc-php-ldap 
doc: LDAP login support, update php requirements list
 2021-07-19 17:02:14 +00:00