From 978538c0de5afcf6cf4a21c0782a6b1e7fa57d9d Mon Sep 17 00:00:00 2001 From: Tilman Vatteroth Date: Sat, 14 Nov 2020 22:24:44 +0100 Subject: Correct repo name Signed-off-by: Tilman Vatteroth --- docs/configuration.md | 2 +- docs/dev/getting-started.md | 2 +- docs/dev/openapi.yml | 8 ++++---- docs/guides/auth/keycloak.md | 2 +- docs/guides/migrate-etherpad.md | 2 +- docs/guides/migrations-and-breaking-changes.md | 4 ++-- docs/history.md | 7 +++++-- docs/setup/heroku.md | 2 +- docs/setup/manual-setup.md | 2 +- 9 files changed, 17 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index 8f2d6263..528e8675 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -29,7 +29,7 @@ to `config.json` before filling in your own details. | `loglevel` | `CMD_LOGLEVEL` | **`info`**, `debug` ... | Defines what kind of logs are provided to stdout. Available options: `debug`, `verbose`, `info`, `warn`, `error` | | `forbiddenNoteIDs` | `CMD_FORBIDDEN_NOTE_IDS` | **`['robots.txt', 'favicon.ico', 'api', 'build', 'css', 'docs', 'fonts', 'js', 'uploads', 'vendor', 'views']`**, `['robots.txt']` or `'robots.txt'` | disallow creation of notes, even if `allowFreeUrl` or `CMD_ALLOW_FREEURL` is `true` | | `imageUploadType` | `CMD_IMAGE_UPLOAD_TYPE` | **`filesystem`**, `imgur`, `s3`, `minio`, `azure`, `lutim` | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md), also there's a whole section on their respective env vars below. | -| `sourceURL` | `CMD_SOURCE_URL` | **no default**, `https://github.com/hedgedoc/server/tree/` | Provides the link to the source code of HedgeDoc on the entry page (Please, make sure you change this when you run a modified version) | +| `sourceURL` | `CMD_SOURCE_URL` | **no default**, `https://github.com/hedgedoc/hedgedoc/tree/` | Provides the link to the source code of HedgeDoc on the entry page (Please, make sure you change this when you run a modified version) | | `tooBusyLag` | `CMD_TOOBUSY_LAG` | **`70`** | CPU time for one event loop tick until node throttles connections. (milliseconds) | | `staticCacheTime` | | **`1 * 24 * 60 * 60 * 1000`** | static file cache time | | `heartbeatInterval` | | **`5000`** | socket.io heartbeat interval | diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md index 9169ea4d..b0623926 100644 --- a/docs/dev/getting-started.md +++ b/docs/dev/getting-started.md @@ -4,7 +4,7 @@ **Notice:** *There's [specialised instructions for docker](../setup/docker.md) or [heroku](../setup/heroku.md), if you prefer running code this way!* -1. Clone the repository with `git clone https://github.com/hedgedoc/server.git hedgedoc-server` +1. Clone the repository with `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc-server` (cloning is the preferred way, but you can also download and unzip a release) 2. Enter the directory and run `bin/setup`, which will install npm dependencies diff --git a/docs/dev/openapi.yml b/docs/dev/openapi.yml index d32a7ef4..aafaddc3 100644 --- a/docs/dev/openapi.yml +++ b/docs/dev/openapi.yml @@ -6,13 +6,13 @@ info: version: 1.6.0 contact: name: HedgeDoc on GitHub - url: https://github.com/hedgedoc/server + url: https://github.com/hedgedoc/hedgedoc license: name: AGPLv3 - url: https://github.com/hedgedoc/server/blob/master/LICENSE + url: https://github.com/hedgedoc/hedgedoc/blob/master/LICENSE externalDocs: - url: https://github.com/hedgedoc/server/blob/master/docs/dev/api.md + url: https://github.com/hedgedoc/hedgedoc/blob/master/docs/dev/api.md paths: @@ -281,7 +281,7 @@ paths: tags: - note summary: Creates a new GitHub Gist with the note's content. - description: 'If [GitHub integration](https://github.com/hedgedoc/server/blob/master/docs/configuration-env-vars.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created.' + description: 'If [GitHub integration](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration-env-vars.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created.' responses: default: description: Redirect to the created gist (or the GitHub authentication before) diff --git a/docs/guides/auth/keycloak.md b/docs/guides/auth/keycloak.md index 6bb3ce7d..8f85d721 100644 --- a/docs/guides/auth/keycloak.md +++ b/docs/guides/auth/keycloak.md @@ -24,7 +24,7 @@ You may note that a separate realm is specified throughout this tutorial. It is 1. Select Client Scopes from the sidebar, and begin to create a new client scope using the Create button. 2. Ensure that the **Name** field is set to `id`. 3. Create a new mapper under the Mappers tab. This should reference the User Property `id`. `Claim JSON Type` should be String and all switches below should be enabled. Save the mapper. -4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/server#56](https://github.com/hedgedoc/server/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. +4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/server#56](https://github.com/hedgedoc/hedgedoc/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. --- diff --git a/docs/guides/migrate-etherpad.md b/docs/guides/migrate-etherpad.md index 00a48d2f..79784ef7 100644 --- a/docs/guides/migrate-etherpad.md +++ b/docs/guides/migrate-etherpad.md @@ -123,6 +123,6 @@ I put this file into my `etherpad.example.com` nginx config, such that all the u redirected accordingly. [etherpad 1.7.0]: https://github.com/ether/etherpad-lite/tree/1.7.0 -[codimd 1.2.1]: https://github.com/hedgedoc/server/tree/1.2.1 +[codimd 1.2.1]: https://github.com/hedgedoc/hedgedoc/tree/1.2.1 [hedgedoc-cli]: https://github.com/hedgedoc/cli/blob/master/bin/hedgedoc [howtolistallpads]: https://github.com/ether/etherpad-lite/wiki/How-to-list-all-pads/49701ecdcbe07aea7ad27ffa23aed0d99c2e17db diff --git a/docs/guides/migrations-and-breaking-changes.md b/docs/guides/migrations-and-breaking-changes.md index 20fa40f5..4c4be1f8 100644 --- a/docs/guides/migrations-and-breaking-changes.md +++ b/docs/guides/migrations-and-breaking-changes.md @@ -9,11 +9,11 @@ We dropped support for node 6 with this version. If you have any trouble running This is not a breaking change, but to stay up to date with the community repository, you may need to update a few urls. This is not a breaking change. -See more at [issue #10](https://github.com/hedgedoc/server/issues/10) +See more at [issue #10](https://github.com/hedgedoc/hedgedoc/issues/10) ### Native setup using git -Change the upstream remote using `git remote set-url origin https://github.com/hedgedoc/server.git`. +Change the upstream remote using `git remote set-url origin https://github.com/hedgedoc/hedgedoc.git`. ### Docker diff --git a/docs/history.md b/docs/history.md index 47792e3b..0c90b626 100644 --- a/docs/history.md +++ b/docs/history.md @@ -34,8 +34,11 @@ move the repository, so we simply forked it. We still welcome the HackMD team as part of our community, especially since a large portion of this code base originated with them. -*For the debate that lead to this step, please refer to the [governance debate](https://github.com/hackmdio/hackmd/issues/1170) and [the announcement of the new repository](https://github.com/hedgedoc/server/issues/10).* +*For the debate that lead to this step, please refer to the [governance debate](https://github.com/hackmdio/hackmd/issues/1170) and [the announcement of the new repository](https://github.com/hedgedoc/hedgedoc/issues/10).* ## CodiMD became HedgeDoc - +Many people were confused about the differences between the hackmd codimd and our codimd. +They asked us about features and bugs, that they found in the HackMD version. +That's why we decided, that we need a unique, new name and in March 2020 we started a [call to participation](https://community.codimd.org/t/renaming-yet-another-time/102). + diff --git a/docs/setup/heroku.md b/docs/setup/heroku.md index ea1356d1..e6280051 100644 --- a/docs/setup/heroku.md +++ b/docs/setup/heroku.md @@ -3,4 +3,4 @@ You can quickly setup a sample Heroku HedgeDoc application by clicking the button below. -[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hedgedoc/server/tree/master) +[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hedgedoc/hedgedoc/tree/master) diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md index f197e477..4900093d 100644 --- a/docs/setup/manual-setup.md +++ b/docs/setup/manual-setup.md @@ -27,7 +27,7 @@ 3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs. -4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](https://github.com/hedgedoc/server/blob/master/docs/configuration.md). +4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md). 5. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development) -- cgit v1.2.3