Commit graph

16 commits

Author SHA1 Message Date
David Mehren
87e0cea2f9
Docs: Cleanup docker page
Build instructions are not relevant for most users.

Contact info can already be found on the 'Home' page.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00
David Mehren
a3ee2c6f8c
Docs: Move migration hints to getting started page
These are relevant for all installation methods, so they should be
placed at a 'global' place.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00
David Mehren
2667b642f4
Docs: Include docker-compose snippet
Directing users to use the container repo to install
HedgeDoc has caused upgrade-trouble in the past, after we made
incompatible changes to the docker-compose.yml in the repo.

This commit inserts a minimal docker-compose snipped in the
docs, which can be used to get started. Upgrading can then
be performed by just incrementing the referenced image version.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:11 +02:00
David Mehren
c54eef10a6
Add an example systemd unit to installation docs
Heavily inspired by the unit of Arch Linux:
https://github.com/archlinux/svntogit-community/blob/packages/hedgedoc/trunk/hedgedoc.service

Fixes https://github.com/hedgedoc/hedgedoc/issues/46

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:18:35 +02:00
David Mehren
3eb049e24b
Migrate container docs to main documentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:18:33 +02:00
David Mehren
1f4388802b
Docs: Improve manual installation guide
- Move the requirements into an info block
- Make clear that we use Yarn Classic
- Link to our downloads page instead of GitHub
- Simplify paragraph about configuring HedgeDoc
- Move additional information into `<small>` tags
- Match upgrade documentation to installation steps.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-15 21:52:58 +02:00
David Mehren
24dbc23ab0
Docs: Add a note about upgrading to the getting started guide
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-13 21:46:40 +02:00
Erik Michelson
185c50b25f
Replace codimd.org link with hedgedoc.org
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2021-04-08 21:43:48 +02:00
David Mehren
bf0a7ebee7
Remove .sequelizerc
After https://github.com/hedgedoc/hedgedoc/pull/969 was merged,
a separate configuration file for the sequelize-cli is no longer
required.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-06 10:34:22 +01:00
Tilman Vatteroth
63b50651df
[Docs] Add "getting started" page
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-03 21:42:49 +01:00
Tilman Vatteroth
dc76d158e7
[Docs] Extend setup page with community methods
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-03 20:54:29 +01:00
Tilman Vatteroth
4d48ef1509
[Documentation] Fix link in manual setup
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-21 21:22:07 +01:00
Tilman Vatteroth
46eda5eead
Rewrite sentence
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-18 16:56:32 +01:00
Tilman Vatteroth
c1d9364a1a
Add page to setup namespace
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-18 16:51:03 +01:00
David Mehren
e9d4587344
Bump version to 1.7.2
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-15 20:37:30 +01:00
Tilman Vatteroth
eaeb88401d
Move docs into subdirectory to make mkdocs work in a subdirectory
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-05 13:15:32 +01:00