From e8e72c5328a3b2f1156b201a85b5608248c4c2c5 Mon Sep 17 00:00:00 2001 From: Philip Molares Date: Sat, 8 Jul 2023 15:39:12 +0200 Subject: [PATCH] docs: run lint:fix Signed-off-by: Philip Molares --- docs/content/dev/design_docs/notes.md | 4 +++- docs/content/dev/docker.md | 8 ++++++-- docs/content/dev/documentation.md | 10 +++++++--- docs/content/dev/getting-started.md | 8 ++++++-- docs/content/index.md | 4 +++- docs/content/setup/getting_started.md | 2 +- 6 files changed, 26 insertions(+), 10 deletions(-) diff --git a/docs/content/dev/design_docs/notes.md b/docs/content/dev/design_docs/notes.md index 8485afa49..225271302 100644 --- a/docs/content/dev/design_docs/notes.md +++ b/docs/content/dev/design_docs/notes.md @@ -7,7 +7,9 @@ Each note in HedgeDoc 2 contains the following information: - publicId (`b604x5885k9k01bq7tsmawvnp0`) -- a list of aliases (`[HedgeDoc-2, HedgeDoc-next]`) + +- a list of aliases (`[hedgedoc-2, hedgedoc-next]`) + - groupPermissions - userPermissions - viewCount (`0`) diff --git a/docs/content/dev/docker.md b/docs/content/dev/docker.md index acbcdb651..e471db3fd 100644 --- a/docs/content/dev/docker.md +++ b/docs/content/dev/docker.md @@ -5,14 +5,18 @@ Make sure that you have installed the [Docker BuildKit Plugin][buildkit] and execute the commands from the root level of the project. Otherwise, the build process may fail. + ```sh -docker buildx build -f backend/docker/Dockerfile -t HedgeDoc-backend . +docker buildx build -f backend/docker/Dockerfile -t hedgedoc-backend . ``` + or + ```sh -docker buildx build -f frontend/docker/Dockerfile -t HedgeDoc-frontend . +docker buildx build -f frontend/docker/Dockerfile -t hedgedoc-frontend . ``` + [buildkit]: https://docs.docker.com/build/install-buildx/ diff --git a/docs/content/dev/documentation.md b/docs/content/dev/documentation.md index 91f6e3ebb..dfd84d95d 100644 --- a/docs/content/dev/documentation.md +++ b/docs/content/dev/documentation.md @@ -5,7 +5,9 @@ Our documentation is build with [mkdocs][mkdocs]. ## Writing All documentation files are found in the `docs/content` directory of -the [HedgeDoc/HedgeDoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal + +the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal + markdown files with nothing special about them. The configuration for mkdocs lies in the `docs` folder in a file called `mkdocs.yml`. With that file @@ -27,8 +29,10 @@ To build the documentation locally you need to perform the following steps: The documentation is deployed with [mkdocs][mkdocs]. -The repository [docs.HedgeDoc.org][docs.HedgeDoc.org] is used to deploy the actual website + +The repository [docs.hedgedoc.org][docs.hedgedoc.org] is used to deploy the actual website + to github.io. Currently only the `master` branch is deployed as it contains the latest release. [mkdocs]: https://www.mkdocs.org -[docs.HedgeDoc.org]: https://github.com/hedgedoc/docs.hedgedoc.org +[docs.hedgedoc.org]: https://github.com/hedgedoc/docs.hedgedoc.org diff --git a/docs/content/dev/getting-started.md b/docs/content/dev/getting-started.md index 83586cc97..9311b0d94 100644 --- a/docs/content/dev/getting-started.md +++ b/docs/content/dev/getting-started.md @@ -18,10 +18,12 @@ and the provided configuration. 1. Clone [our repository][hedgedoc-repo] and go into its directory + ```shell git clone https://github.com/hedgedoc/hedgedoc.git - cd HedgeDoc + cd hedgedoc ``` + 2. Install Node.js. You need at least Node 16, but we recommend Node 20. 3. Install [Yarn][yarn] @@ -48,7 +50,9 @@ If you want to run HedgeDoc in dev mode some preconditions have to be met. 1. Make sure that Node.js is installed. You need at least Node 16, but we recommend Node 18. 2. Make sure that [Yarn][yarn] is installed. -3. Clone this repo (e.g. `git clone https://github.com/hedgedoc/hedgedoc.git HedgeDoc`) + +3. Clone this repo (e.g. `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc`) + 4. Go into the cloned directory ## Installing the dependencies diff --git a/docs/content/index.md b/docs/content/index.md index 875b6ed03..2c947a617 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -7,7 +7,9 @@ ๐Ÿšงโš ๏ธ๐Ÿšง **HedgeDoc 2.0 is still in development!** You are probably looking for the 1.x docs. -Find them in the `master` branch and on [docs.HedgeDoc.org](https://docs.hedgedoc.org). + +Find them in the `master` branch and on [docs.hedgedoc.org](https://docs.hedgedoc.org). + If you want to help us to develop HedgeDoc 2, join us on [Matrix][matrix.org-url]! diff --git a/docs/content/setup/getting_started.md b/docs/content/setup/getting_started.md index f46953c61..f673e6272 100644 --- a/docs/content/setup/getting_started.md +++ b/docs/content/setup/getting_started.md @@ -17,7 +17,7 @@ You will have to accept the TLS warning in your browser the first time the page !!! danger "HedgeDoc 2 is not yet production ready!" This section explains how a production deployment of HedgeDoc 2 on a publicly accessible domain might look in the future. - HedgeDoc 2 itself is not production ready yet, so only use these instructions to set up an + HedgeDoc 2 itself is not production ready yet, so only use these instructions to set up an instance for testing with your friends. For a production setup, first set a unique session secret with