Commit graph

55 commits

Author SHA1 Message Date
Philip Molares
8c78656f8c docs: add dev documentation for create methods
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-11-11 22:15:00 +01:00
Philip Molares
49c1c8de34 docs: add primary aliases to the dev doc about notes
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-09-22 20:43:45 +02:00
Philip Molares
aaef0f72ba feat: add list of aliases to note entity
One of the aliases can be primary for each note, but all can be used to get information from the apis.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-09-21 15:14:00 +02:00
Philip Molares
b2da8a2b95 chore: move identity entity in its own folder
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-09-16 23:59:59 +02:00
Philip Molares
bf3ec53c78 docs: add documentation on private api authentication
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-09-09 21:08:23 +02:00
Philip Molares
0512308159 Docs: Add configuration documentation
This adds documentation for the configuration of HedgeDoc.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-08-05 21:43:29 +02:00
David Mehren
0d6c300254
Allow anonymous user colors in DB schema
Every authorship now has an author that saves the color.
The author links to the session and optionally the user.
For anonymous users, the session now can be used to reidentify the user.
 If the user is logged-in, the userId is saved into the author table.
 This allows to identify the user even after the session expired.

 A note created by an anonymous user does not have an owner.
 The cardinality was updated to reflect that.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-05-31 17:38:58 +02:00
Philip Molares
ae95c50aa4 chore(plantuml): Add publicId to note
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-05-17 20:27:43 +02:00
Philip Molares
8c562016ab Refactor(note): Remove shortid from note
This is a 1.x relict and isn't used anymore in 2.x. All 1.x shortids will be converted to aliases on migration of 1.x to 2.x.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-05-11 22:49:44 +02:00
David Mehren
0e5552de4d
Merge pull request #1190 from hedgedoc/docs/fixMkdocsLink
Docs: Fix mkdocs link
2021-04-25 21:14:45 +02:00
Philip Molares
96fdc15401 Docs: Fix mkdocs link
The link that was included in the reference was surrounded by paranthesis and therefore faulty.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-25 20:57:13 +02:00
Philip Molares
a15722b864 Documentation: Add toggleable dark theme
The dark theme is mostly built on top of the mkdocs slate theme.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
Co-Authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>

(cherry picked from commit 60251d89ee)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-25 12:50:02 +02:00
David Mehren
32d9f21630
Merge pull request #1141 from hedgedoc/mediaBackend/webDAV 2021-04-18 22:22:28 +02:00
Philip Molares
2d86b149a0 Documentation: Add WebDAV media guide
This explains how to use the WebDAV media backend both in general and with a NextCloud in particular.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-18 21:54:40 +02:00
Philip Molares
091d6ee9b4 Add dev docs about notes
fixes #864

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-15 22:20:27 +02:00
Yannick Bungers
429eff4411
Merge pull request #1066 from hedgedoc/docs/hfm 2021-03-31 21:53:28 +02:00
Philip Molares
c4e5ffbe7a Docs: Add footnotes extension
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-28 22:54:56 +02:00
Yannick Bungers
25bdbf647a
Merge pull request #1032 from hedgedoc/docs/authentication
Add dev docs about user profiles and authentication
2021-03-28 22:41:12 +02:00
Philip Molares
60f73a5c84 Docs: Add hedgedoc flavored markdown reference
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-25 22:33:07 +01:00
David Mehren
97525377c7
Add dev docs about user profiles and authentication
Closes #463
Closes #451
Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-25 21:51:17 +01:00
David Mehren
7775b0a288
Merge pull request #1050 from hedgedoc/fix/devDocs
Docs: Fix dev doc 'documentation'
2021-03-25 20:25:48 +01:00
David Mehren
6e03f876db
Merge pull request #1033 from hedgedoc/docs/delete_revisions 2021-03-24 22:15:27 +01:00
Philip Molares
db9d42e7f3 Docs: Fix dev doc 'documentation'
Fix typos
Rewrite 'Deployment' paragraph. We currently don't and probably won't use Messor Structor.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-24 20:32:56 +01:00
Philip Molares
bd9235c5c9 DevDocs: Add explanations for new config modules
The new config modules `customization` and `external-services` are explained in the dev doc overview of all config modules now.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-21 20:08:13 +01:00
David Mehren
c01eb61f19
Add dev docs about deleting notes & revisions
Fixes #560

Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-21 17:45:45 +01:00
Philip Molares
b5575bbebe MediaService: Remove allowedMimeType application/pdf
Uploading PDFs does not work with imgur and therefore HedgeDoc should not offer that.

See #533

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-15 22:41:40 +01:00
Yannick Bungers
ef352a1313 Add GET /me/media
Returns all media files uploaded by the authenticated user.

Signed-off-by: Yannick Bungers <git@innay.de>
2021-03-14 17:47:16 +01:00
Philip Molares
48052c609f Docs: Add Azure, Filesystem, Imgur and S3
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-06 17:12:14 +01:00
Philip Molares
eb7e6b55eb DBSchema: Add fileUrl to media_upload table
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-27 22:03:09 +01:00
Yannick Bungers
e351d8557a Docs: Add description for special groups
Signed-off-by: Yannick Bungers <git@innay.de>
2021-02-27 14:16:29 +01:00
Yannick Bungers
b7e188cec2 Rename viewcount to viewCount for compliance
Signed-off-by: Yannick Bungers <git@innay.de>
2021-02-22 23:36:44 +01:00
David Mehren
5fac0db8a6
Document supported databases in 2.0
Closes #447

Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-19 12:50:16 +01:00
David Mehren
443f58e39d
Add intention of 2.0 development docs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-19 12:43:55 +01:00
Yannick Bungers
f8e07f6940 Add relation between User and Group
This represents the users which are members of this group

Signed-off-by: Yannick Bungers <git@innay.de>
2021-02-18 22:25:52 +01:00
Philip Molares
14ec1ca120 Docs: Add interface documentation for the toolbar
This documentation explains HedgeDoc's toolbar to new users.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-16 20:59:03 +01:00
Philip Molares
c0e797bca6 Dev Docs: Add configuration to navigation
This makes it possible to access the developer documentation about configuration code.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-05 23:12:52 +01:00
Philip Molares
7cdb40585e Dev Docs: Add configuration documentation
This explains how the configuration code works and give some hints on what do look out for while working on the configuration code.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-05 23:08:32 +01:00
David Mehren
763f67d5fb
Merge pull request #801 from hedgedoc/feature/history 2021-02-05 21:30:52 +01:00
David Mehren
d4dcae7d79
Update docs with hint about 2.0 development
Replace the old docs index page with a hint where the (for now) 'real'
docs can be found and that HedgeDoc 2.0 is still in development.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 21:55:27 +01:00
Philip Molares
b76fa91a3c History: Add HistoryEntry
With this the backend now can hold a history entry.
Also included in this commit are some minor changes to tests and services so they can still work.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-04 21:50:14 +01:00
David Mehren
55703e0aec
Delete old docs not relevant for 2.x
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 21:47:04 +01:00
Philip Molares
0a3247492a auth: Add cron to clean old tokens
Rename AuthToken.identifier to label

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-25 21:30:04 +01:00
Philip Molares
599fe57ec6 tokens: Add token creation
Fix token deletion
Update plantuml docs
Add token validUntil and lastUsed fields

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-25 21:30:02 +01:00
Philip Molares
0bd7a8f4bc db-schema: updates plantuml
adds identifier and createdAt to AuthToken
renames authToken in User to authTokens

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-25 21:29:52 +01:00
Yannick Bungers
17ceb9c31f Removed special table name in Note object
and changed table names in plantuml file

Signed-off-by: Yannick Bungers <git@innay.de>
2021-01-23 22:26:49 +01:00
David Mehren
4a1bec8eec
Move note permission route under metadata
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-10 20:25:28 +01:00
David Mehren
e15fb2c8a3
Merge branch 'develop' into develop 2021-01-10 18:04:32 +01:00
David Mehren
ffce2de2db
Merge branch 'develop' into docs/cherrypickHistory 2021-01-10 17:52:49 +01:00
Philip Molares
6d5710a917 Fix some typos in history.md
(cherry picked from commit 0195d074a8)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-09 12:35:51 +01:00
Simon C
4559d52d52 docs: Fix indentation of code 2021-01-08 14:58:01 +01:00