Commit graph

401 commits

Author SHA1 Message Date
Philip Molares
09698579a7 fix: docs deployment
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-10-08 17:54:39 +02:00
Philip Molares
c1aa396a3e fix: docs deployment
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-10-08 17:44:00 +02:00
Philip Molares
576815013c fix: docs deployment
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-10-08 17:31:59 +02:00
Philip Molares
e09ddcb7ab fix: docs deployment
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-10-08 16:53:57 +02:00
renovate[bot]
f3a3055e08 chore(deps): update yarn to v3.6.4
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-10-07 12:44:15 +00:00
Philip Molares
5335c48df7 feat(config): warn user about not yet supported config
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-10-07 14:33:21 +02:00
Philip Molares
d43da06ec1 refactor: remove dropbox, facebook & twitter login
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-10-07 13:28:37 +02:00
David Mehren
0693812e8b refactor: remove HstsConfig
This config object was originally ported from the HD1 config,
but is not required anymore.

HD2 does not support handling TLS anymore, so it does not make
sense for it to set TLS-related headers.
The reverse proxy terminating TLS can easily set HSTS headers.

Signed-off-by: David Mehren <git@herrmehren.de>
2023-10-07 11:10:37 +02:00
renovate[bot]
bf3e7e1f44 chore(deps): update dependency mkdocs-material to v9.4.4
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-10-05 22:04:14 +00:00
renovate[bot]
288504f718 chore(deps): update dependency mkdocs-material to v9.4.3
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-10-02 12:25:33 +00:00
renovate[bot]
aa1b4b1a47 chore(deps): update dependency mkdocs-material to v9.4.2
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-25 09:40:57 +00:00
renovate[bot]
404c253930 chore(deps): update dependency mkdocs-material to v9.4.1
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-22 16:47:15 +00:00
renovate[bot]
64db7c7f79 chore(deps): update dependency mkdocs-material to v9.4.0
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-22 11:14:58 +02:00
renovate[bot]
9d6ce53bac chore(deps): update dependency markdownlint-cli2 to v0.10.0
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-22 10:37:27 +02:00
renovate[bot]
fd1f2e2240 chore(deps): update dependency mkdocs-material to v9.3.2
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-20 06:47:05 +00:00
renovate[bot]
c97ddc114e chore(deps): update dependency mkdocs to v1.5.3
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-19 18:39:35 +00:00
Philip Molares
5ed1fa18d6 fix: fix links to other files
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-09-17 21:50:21 +02:00
Philip Molares
e07cd62596 docs: restructure documentation
This rewrite follows the principles of https://diataxis.fr/

Co-authored-by: Erik Michelson <github@erik.michelson.eu>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-09-17 21:50:21 +02:00
Philip Molares
e0dd24ed29 refactor: move dco into root
They never really belonged into the docs anyway, but somehow were stuck there

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-09-17 21:50:21 +02:00
renovate[bot]
5909356585 chore(deps): update dependency mkdocs-material to v9.3.1
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-17 20:45:48 +02:00
renovate[bot]
18a1e79d9f chore(deps): update dependency mkdocs-material to v9.2.8
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-04 21:06:07 +00:00
renovate[bot]
8e8df44f8c chore(deps): update dependency pymdown-extensions to v10.3
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-03 10:14:17 +02:00
renovate[bot]
915e3ad101 chore(deps): update dependency mkdocs-material to v9.2.7
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-02 17:33:12 +00:00
renovate[bot]
57a7fdddf8 chore(deps): update dependency mkdocs-material to v9.2.6
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-02 12:03:02 +00:00
renovate[bot]
61e8d80cec chore(deps): update dependency pymdown-extensions to v10.2.1
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-02 13:55:22 +02:00
renovate[bot]
5fce2791c4 chore(deps): update dependency mkdocs-material to v9.2.5
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-27 12:54:39 +00:00
renovate[bot]
e64a838449 chore(deps): update dependency mkdocs-material to v9.2.4
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-26 12:21:43 +00:00
renovate[bot]
b6a13439f8 chore(deps): update yarn to v3.6.3
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-26 09:31:55 +00:00
renovate[bot]
07d9510b01 chore(deps): update dependency markdownlint-cli2 to v0.9.2
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-26 06:47:04 +00:00
renovate[bot]
3adb79f0de chore(deps): update dependency markdownlint-cli2 to v0.9.1
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-26 04:55:37 +00:00
renovate[bot]
2cb23029c5 chore(deps): update dependency markdownlint-cli2 to v0.9.0
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-25 19:57:26 +02:00
renovate[bot]
99f72ae11a chore(deps): update dependency mkdocs-material to v9.2.3
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-25 19:56:52 +02:00
renovate[bot]
1a4e234494 chore(deps): update yarn to v3.6.2
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-19 09:39:51 +00:00
renovate[bot]
4d0b05c4c1 chore(deps): update dependency mkdocs to v1.5.2
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-02 15:14:24 +00:00
renovate[bot]
ea97c24637 chore(deps): update dependency mkdocs to v1.5.1
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-30 10:04:30 +02:00
renovate[bot]
489d996e9a chore(deps): update dependency mkdocs-material to v9.1.21
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-29 10:19:32 +00:00
renovate[bot]
fbd8137eb8 chore(deps): update dependency mkdocs-material to v9.1.20
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-27 10:48:22 +00:00
Philip Molares
d185e2e694 refactor: rename HD_AUTH_LDAPS to HD_AUTH_LDAP_SERVERS
This was done as LDAPS us both the plural of LDAP and the common abbreviation for secure LDAP connections.

Fixes #4460

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-07-22 11:37:17 +02:00
renovate[bot]
7853d5f4c5 chore(deps): update dependency mkdocs-material to v9.1.19
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-18 13:45:06 +00:00
renovate[bot]
33a545c65a chore(deps): update dependency pymdown-extensions to v10.1
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-14 20:07:38 +02:00
Philip Molares
e8e72c5328 docs: run lint:fix
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-07-09 20:07:07 +02:00
Philip Molares
50d4959e0a docs: run lint:fix
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-07-09 20:07:07 +02:00
Philip Molares
366515e760 ci: add workflow to lint documentation
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-07-09 20:07:07 +02:00
renovate[bot]
e5fdaf8dfe chore(deps): update dependency mkdocs-material to v9.1.18
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-03 16:18:19 +00:00
Juned Khan
723c5752bd doc: Added documentation to enable debug logging in prod
Signed-off-by: Juned Khan <junedkhanc101@gmail.com>
2023-07-02 14:33:06 +02:00
renovate[bot]
3ebed23468 chore(deps): update dependency mkdocs-material to v9.1.17
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-24 13:15:31 +00:00
Tilman Vatteroth
7fdd11f9ff fix: add license files for developer-certificate-of-origin.txt
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-06-21 15:31:10 +02:00
renovate[bot]
5a677bf481 chore(deps): update dependency mkdocs-material to v9.1.16
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-15 19:48:34 +00:00
Tilman Vatteroth
40cc8cd7f2 doc: correct name of permission env vars
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-06-06 22:10:20 +02:00
renovate[bot]
be1640df3a chore(deps): update dependency mkdocs-material to v9.1.15
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-05-29 18:43:09 +00:00
renovate[bot]
9af8d5927c chore(deps): update dependency mkdocs-material to v9.1.14
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-20 14:12:32 +00:00
renovate[bot]
203019afed chore(deps): update dependency mkdocs-material to v9.1.13
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-16 23:46:34 +00:00
renovate[bot]
54f4a0bd10 chore(deps): update dependency pymdown-extensions to v10.0.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-16 12:07:03 +02:00
renovate[bot]
fe8e7fbbf4 chore(deps): update dependency pymdown-extensions to v10 [security]
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-16 12:00:07 +02:00
Philip Molares
f306593e6c docs: update ldap dev docs
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-12 21:11:45 +02:00
Philip Molares
4bf2ca4ca7 docs: update ldap dev docs
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-12 21:11:45 +02:00
Philip Molares
06659ce0a7 docs: add ldap auth method
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-12 21:11:45 +02:00
renovate[bot]
033bf0e3d7 chore(deps): update dependency mkdocs-material to v9.1.12
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-12 19:02:10 +02:00
Philip Molares
0932481117 docs: add images for customization docs
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-10 20:20:17 +02:00
Philip Molares
e86e40a61b docs: indent imgur warning correctly
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-10 13:57:25 +02:00
Tilman Vatteroth
23901d1454 chore: change recommended and CI node version to v20
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-05-10 13:43:05 +02:00
renovate[bot]
5519620460 chore(deps): update dependency mkdocs-material to v9.1.11
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-08 21:36:05 +02:00
renovate[bot]
888c4e1662 chore(deps): update dependency mkdocs-material to v9.1.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-08 21:28:02 +02:00
Philip Molares
a44e364553 docs(imgur): add warning about new imgur policy
Because imgur will delete images 6 month after the last access, we should tell our users about this change to help them make a informed decision about their media backend choice…

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-07 22:42:58 +02:00
renovate[bot]
fc00b39234 chore(deps): update dependency mkdocs to v1.4.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-03 02:12:47 +00:00
renovate[bot]
55272ed2b9 chore(deps): update dependency mkdocs-material to v9.1.9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-02 12:10:35 +02:00
renovate[bot]
f2c1aade4e chore(deps): update dependency mkdocs-material to v9.1.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-25 09:31:38 +02:00
renovate[bot]
08fdc8cd0a chore(deps): update dependency mkdocs-material to v9.1.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-22 18:11:34 +00:00
Tilman Vatteroth
d8c1e35819 docs(docs): make clear that the s3 endpoint must be a URL
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-04-16 18:41:03 +02:00
Tilman Vatteroth
476aff890e fix: usage of .env file in getting-started dev guide
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-04-13 10:39:17 +02:00
renovate[bot]
7056f137dc chore(deps): update dependency pymdown-extensions to v9.11
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-07 22:35:00 +02:00
renovate[bot]
3e3b46a81b chore(deps): update dependency mkdocs-material to v9.1.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-07 22:20:08 +02:00
renovate[bot]
c1f83cb699 chore(deps): update dependency mkdocs-material to v9.1.5
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-31 09:56:23 +00:00
David Mehren
57701b5d6c docs: add note about separate renderer domain
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-26 15:53:49 +02:00
David Mehren
80eb4c8a1a docs: change default session secret in docker deployment
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-26 15:53:49 +02:00
David Mehren
f7f052fca1 refactor: use separate env vars for frontend/backend port
As we moved to a combined .env file for simplicity, frontend and backend need to be configured with separate variables.

Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-26 15:53:49 +02:00
David Mehren
b538c2c2a3 docs: minor fixes for config docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-25 13:05:42 +01:00
David Mehren
520d0933cb docs: add getting started guide
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-25 13:05:42 +01:00
David Mehren
26da4c6327 docs: consistent Markdown formatting
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
31969c56eb docs: add missing design docs disclaimer
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
b5e64880cd docs: Add docker docs to navbar
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
c278f6d78b docs: Split up 2.0.md and rename to dev_notes.md
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
bec48f3c22 docs: Add frontend docs to navbar
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
3c957e9b0e docs: Move 'Events' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
58f306a38c docs: Merge API Authentication docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
1093da4a39 docs: Move 'Notes' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
c9f8285f57 docs: Move 'Configuration' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
162a8e8816 docs: Move 'User Profiles & Authentication' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
8bb39b8c6d docs: introduce 'Design Documents' category
These documents provide context for various application aspects.

This commit also fixes the indentation and missing lists in the mkdocs config.

Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
renovate[bot]
4707540237 chore(deps): update dependency mkdocs-material to v9.1.4
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-24 15:36:21 +01:00
renovate[bot]
df1ef869c9 chore(deps): update dependency mkdocs-material to v9.1.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-14 20:46:10 +01:00
renovate[bot]
9f58da017f chore(deps): update dependency mkdocs-material to v9.1.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-11 09:14:23 +01:00
renovate[bot]
4f2415c311 chore(deps): update dependency pymdown-extensions to v9.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-05 18:58:00 +01:00
renovate[bot]
c88b3830e0 chore(deps): update dependency mkdocs-material to v9.1.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-05 18:42:07 +01:00
renovate[bot]
ec28a04ad2 chore(deps): update dependency mkdocs-material to v9.0.15
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-26 12:56:41 +01:00
Tilman Vatteroth
6705e1350f docs: Remove node 14 from getting-started.md
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-25 21:06:36 +01:00
renovate[bot]
3b1795d854 chore(deps): update dependency mkdocs-material to v9.0.14
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-25 13:47:37 +01:00
Philip Molares
1c16e25e14 feat(frontend): replace forkawesome with bootstrap icons
These icon replace fork awesome. A linter informs the user about the deprecation.

See https://github.com/hedgedoc/hedgedoc/issues/2929

Co-authored-by: Philip Molares <philip.molares@udo.edu>
Co-authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-24 14:31:17 +01:00
Tilman Vatteroth
e7246f1484 fix(docs): reformat hfm.md
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-22 17:02:25 +01:00
renovate[bot]
d5645c7bfd chore(deps): update dependency mkdocs-material to v9.0.13
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-18 20:02:27 +01:00