nodiscc
ca07f265f1
Merge pull request #2037 from nodiscc/doc-title-retrieval-limitations
...
doc: troubleshooting: automatic title retrieval fails when it is set by javascript
2023-11-15 15:52:26 +00:00
nodiscc
4557abb981
Merge pull request #2036 from nodiscc/doc-general-download-timeout-max-size
...
doc: document general.download_max_size/timeout configuration settings
2023-11-15 15:51:58 +00:00
nodiscc
c88bc1d760
Merge pull request #2035 from nodiscc/doc-rm-bountysource
...
doc: remove bountysource badge
2023-11-15 15:51:33 +00:00
nodiscc
bd3e71cacb
doc: automatic title retrieval fails when it is set by javascript
...
- related https://github.com/shaarli/Shaarli/issues/531
- fixes https://github.com/shaarli/Shaarli/issues/989
2023-11-15 16:04:39 +01:00
nodiscc
1697e7a4bd
doc: document general.download_max_size/timeout configuration settings
...
- fixes https://github.com/shaarli/Shaarli/issues/2034
2023-11-15 15:56:30 +01:00
nodiscc
db71d2fcd4
doc: remove bountysource badge
...
- fixes https://github.com/shaarli/Shaarli/issues/2033
2023-11-15 15:50:33 +01:00
nodiscc
2caa586a4d
Merge pull request #2030 from nodiscc/doc-cleanup-3rdparty
...
doc: themes: remove unmaintained themes
2023-11-04 14:31:49 +00:00
nodiscc
c60a42890b
doc: themes: remove unmaintained theme shaarli-blocks
...
- Attention: This theme will no longer be updated
- unmaintained since 2015
2023-11-02 16:40:51 +01:00
nodiscc
beb683e463
doc: themes: remove unmaintained theme dhoko/ShaarliTemplate
...
- unmaintained since 2014, shaarli 0.0.45
2023-11-02 16:40:10 +01:00
nodiscc
408b7e7d0a
doc: themes: remove unmaintained theme shaarli-launch
...
- This repository has been archived by the owner on Aug 16, 2018. It is now read-only.
- This theme is no longer maintained and won't get any support or update.
2023-11-02 16:38:40 +01:00
nodiscc
646f63e413
doc: themes: remove incompatible albinomouse theme
...
- not compatible with shaarli >=0.9 https://github.com/alexisju/albinomouse-template/issues/9
2023-11-02 16:37:57 +01:00
nodiscc
a98553b601
doc: themes: remove unmaintained superhero theme
...
- This repository has been archived by the owner on Oct 28, 2019. It is now read-only.
2023-11-02 16:36:46 +01:00
nodiscc
2ef90ec791
Merge pull request #2028 from dajare/add-stack-theme
...
Add shaarli-stack theme to Community-and-related-software.md
2023-11-01 17:33:17 +00:00
David
0222e62ea4
Add shaarli-stack theme to Community-and-related-software.md
2023-11-01 15:02:47 +00:00
nodiscc
5b21103d76
Merge pull request #2027 from shaarli/dependabot/npm_and_yarn/browserify-sign-4.2.2
...
build(deps): bump browserify-sign from 4.2.1 to 4.2.2
2023-10-27 14:03:16 +00:00
dependabot[bot]
728169f185
build(deps): bump browserify-sign from 4.2.1 to 4.2.2
...
Bumps [browserify-sign](https://github.com/crypto-browserify/browserify-sign ) from 4.2.1 to 4.2.2.
- [Changelog](https://github.com/browserify/browserify-sign/blob/main/CHANGELOG.md )
- [Commits](https://github.com/crypto-browserify/browserify-sign/compare/v4.2.1...v4.2.2 )
---
updated-dependencies:
- dependency-name: browserify-sign
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com>
2023-10-27 13:31:57 +00:00
nodiscc
78f7a338c1
Merge pull request #2026 from shaarli/dependabot/npm_and_yarn/babel/traverse-7.23.2
...
build(deps): bump @babel/traverse from 7.14.0 to 7.23.2
2023-10-17 09:48:01 +00:00
dependabot[bot]
bfdbb62cd1
build(deps): bump @babel/traverse from 7.14.0 to 7.23.2
...
Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse ) from 7.14.0 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases )
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md )
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse )
---
updated-dependencies:
- dependency-name: "@babel/traverse"
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com>
2023-10-17 03:49:22 +00:00
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
