Commit graph

2415 commits

Author SHA1 Message Date
nodiscc ba21aa60d9
Merge pull request #2025 from nodiscc/doc-sphinx
replace mkdocs with sphinx/myst-parser for HTML documentation generation, documentation improvements
2023-10-15 16:16:49 +00:00
nodiscc 484ee2bbb0
tool/.gitattributes: exclude doc/html/.doctrees/ from zip exports
- https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-d
- https://stackoverflow.com/questions/33904042/is-doctrees-folder-required-for-displaying-html-docs-with-sphinx
2023-10-06 12:33:01 +02:00
nodiscc e5545436b0
doc: development/release procedure: version number must be bumped in doc/conf.py and README.mdn as well 2023-10-05 15:28:22 +02:00
nodiscc 00db4f6bcc
doc: update external links based on redirects, fix/remove dead links
- checked with python -m sphinx -b linkcheck -c doc doc/md doc/linkcheck
2023-10-05 15:02:00 +02:00
nodiscc e7a2d06a63
doc: server configuration: standardize whitespace/newlines 2023-10-05 15:01:56 +02:00
nodiscc 00ccae495c
doc: server configuration: update apache configuration, use php-fpm
- remove apache 2.2 configuration (2.4 was released in 2012)
2023-10-05 15:01:56 +02:00
nodiscc 1e7419eca9
doc: server configuration: replace fireHOL (unmaintained) with firewalld 2023-10-05 15:01:50 +02:00
nodiscc 2a88f7a526
doc: index: remove inline icon 2023-10-05 15:01:50 +02:00
nodiscc 8d3e224936
doc: index: remove a screenshot thumbnail so that all thumbnails fit on one line 2023-10-05 15:01:43 +02:00
nodiscc 4e653e1e97
tools/github actions: use makefile/sphinx instead of mkdocs to build HTML documentation 2023-10-05 15:01:43 +02:00
nodiscc 00264cb4a1
doc: community & related software: remove unmaintained shaarli forks (since 2014/2015) 2023-10-05 15:01:43 +02:00
nodiscc ee5ee294b2
doc: server configuration: remove outdated screencast
- ref. https://github.com/shaarli/Shaarli/issues/2002
- uses old instructions/mod-php instead of the now recommended php-fpm
- server configuration may not be the ideal page for this, installation would be more suitable
2023-10-05 15:01:43 +02:00
nodiscc 81cfed8be4
doc: use relative links when possible 2023-10-05 15:01:42 +02:00
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 c4d3e2d7ec
Merge pull request #2024 from nodiscc/update-alpine-3.16
docker: update base alpine docker image to 3.16.7
2023-10-03 16:46:44 +00:00
nodiscc 5db074fdef
docker: update base alpine docker image to 3.16.7
- the previous (0.12.2) release image was based on 3.16.4 since the .patch version was not specified, which shows vulnerabilities when scanned with trivy (https://github.com/shaarli/Shaarli/pull/2019)
2023-10-03 18:43:25 +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 775fcb44f9
Merge pull request #2018 from nodiscc/doc-debian-package
doc: community/related software/integration with other platforms: add link to shaarli debian package
2023-09-08 19:43:19 +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 572c55f0b1
Merge pull request #2015 from nodiscc/doc-fix-mkdocs-warnings
doc: fix mkdocs build warnings/relative links
2023-08-20 21:18:28 +00: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 5a6515c988
Merge pull request #2014 from nodiscc/build-docker-pr
tools: github actions: build docker images on pull requests
2023-08-19 11:48:29 +00:00
nodiscc ea57088177
tools: github actions: build docker images on pull requests
- fixes https://github.com/shaarli/Shaarli/issues/1800
- do not push, only check that the image builds correctly
- tag the image as :pr-PR_NUMBER
2023-08-19 13:44:58 +02:00
nodiscc 638a7c5141
Merge pull request #2012 from nodiscc/update-trivy
tools/tests: update trivy to v0.44.0
2023-08-01 13:22:05 +00:00
nodiscc c937d3e184
tools/tests: update trivy to v0.44.0
- https://github.com/aquasecurity/trivy/releases/tag/v0.44.0
2023-08-01 15:10:57 +02:00
nodiscc 4cbba2fe64
Merge pull request #2010 from shaarli/dependabot/npm_and_yarn/word-wrap-1.2.4
build(deps): bump word-wrap from 1.2.3 to 1.2.4
2023-07-19 13:47:28 +00:00
dependabot[bot] 949e03ca1f
build(deps): bump word-wrap from 1.2.3 to 1.2.4
Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](https://github.com/jonschlinkert/word-wrap/compare/1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-19 00:03:56 +00:00
nodiscc e91984b507
Merge pull request #2008 from clach04/patch-1
Doc update, WebSub (formerly PubSubHubbub) plugin
2023-07-15 12:31:18 +00:00
clach04 f812581234
Doc update, WebSub (formerly PubSubHubbub) plugin
Clarify old and new name along with Wikipedia link.
2023-07-15 02:11:57 -07:00
nodiscc 5af1c9dbae
Merge pull request #2006 from shaarli/dependabot/npm_and_yarn/semver-5.7.2
build(deps): bump semver from 5.7.1 to 5.7.2
2023-07-11 11:00:35 +00:00
nodiscc e7ff18c864
Merge pull request #2005 from nodiscc/update-trivy
tools/Makefile: update trivy to v0.43.1
2023-07-11 10:53:05 +00:00
dependabot[bot] 66982b6f79
build(deps): bump semver from 5.7.1 to 5.7.2
Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v5.7.1...v5.7.2)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-11 03:32:45 +00:00
nodiscc 6d16b6c8a8
tools/Makefile: update trivy to v0.43.1
è https://github.com/aquasecurity/trivy/releases/tag/v0.43.1
2023-07-08 21:18:37 +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 d24fc65695
Merge pull request #1998 from nodiscc/trivy-repo-scan
tools/CI: scan repository with trivy security scanner (yarn.lock, composer.lock)
2023-07-06 16:37:13 +00:00
Amadeous c44a0d200d
Expose tags_separator config through /info API (#1997) 2023-06-30 22:15:41 +00:00
Alistair Young 9fd6739a1f
docker: nginx: listen on IPv6 in addition to IPv4 (#1983) 2023-06-30 22:08:02 +00:00
nodiscc 3b5923b7e1
tools/CI: scan repository with trivy security scanner (yarn.lock, composer.lock)
- run scan on each push/pull request update
- can be run locally using make test_trivy_repo
- exit with error code 0/success when vulnerabilities are found,  as not to make the workflow fail, a separate periodic run that exits with code 1 should be added in parallel
- update trivy to v0.43.0
- https://github.com/aquasecurity/trivy/releases/tag/v0.43.0
- also consider TRIVY_EXIT_CODE when running trivy on the latest docker image
- ref. https://github.com/shaarli/Shaarli/issues/1531
2023-06-30 23:56:09 +02:00
nodiscc 467b28c237
Merge pull request #1989 from nodiscc/trivy-fix-target-docker-image
gihub actions: fix value of TRIVY_TARGET_DOCKER_IMAGE
2023-05-21 19:10:36 +00:00
nodiscc 0eee6a2ba1
gihub actions: fix value of TRIVY_TARGET_DOCKER_IMAGE
- fixes Error response from daemon: no such image: ghcr.io/***:trivy: No such image: ghcr.io/***:trivy
- introduced in https://github.com/shaarli/Shaarli/pull/1980 but the test target branch/tag was never reverted to 'latest'
2023-05-21 21:08:36 +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