From b28839484d120c04c5a06e7f8318650c78ab195b Mon Sep 17 00:00:00 2001 From: Erik Michelson Date: Thu, 2 Jul 2020 17:22:52 +0200 Subject: Replace CodiMD with HedgeDoc Signed-off-by: Erik Michelson Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in public/views Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in README Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in SECURITY.md Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in LICENSE Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in docs/configuration.md Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in bin/setup Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/guides Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/dev Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/guides/auth Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/setup Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update various links in code to the new GitHub org. Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: codiMDVersion.js is now hedgeDocVersion.js Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/setup/yunohost Signed-off-by: Tilman Vatteroth Rebrand to HedgeDoc: Add banner and logo Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in docs/guides/migrate-etherpad Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Remove note in docs/guides/auth/github Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace links in public/docs/features Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add todo placeholder in docs/history Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace github link in public/views/index/body Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace github link in README Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add logo to README Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add note about the renaming to the front page Signed-off-by: Tilman Vatteroth Removed Travis from README.md and change CodiMD to HedgeDoc in some places Signed-off-by: Yannick Bungers Some more renaming to HedgeDoc - Fixed capitalization of HedgeDoc - Added renaming for etherpad migration doc Signed-off-by: Yannick Bungers Changed Repo name to hedgedoc Signed-off-by: Yannick Bungers --- docs/dev/api.md | 8 ++++---- docs/dev/getting-started.md | 6 +++--- docs/dev/openapi.yml | 18 +++++++++--------- 3 files changed, 16 insertions(+), 16 deletions(-) (limited to 'docs/dev') diff --git a/docs/dev/api.md b/docs/dev/api.md index fbbdae83..5422533d 100644 --- a/docs/dev/api.md +++ b/docs/dev/api.md @@ -1,5 +1,5 @@ # API documentation -Several tasks of CodiMD can be automated through HTTP requests. +Several tasks of HedgeDoc can be automated through HTTP requests. The available endpoints for this api are described in this document. For code-autogeneration there is an OpenAPIv3-compatible description available [here](openapi.yml). @@ -34,9 +34,9 @@ These endpoints return information about the current logged-in user and it's not | `/history/` | `POST` | **Toggles the pinned status in the history for a note.**
The body must be form-encoded and contain a field `pinned` that is either `true` or `false`. | | `/history/` | `DELETE` | **Deletes a note from the user's history.** | -## CodiMD-server -These endpoints return information about the running CodiMD instance. +## HedgeDoc-server +These endpoints return information about the running HedgeDoc instance. | Endpoint | HTTP-Method | Description | | --------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `/status` | `GET` | **Returns the current status of the CodiMD instance.**
The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. | +| `/status` | `GET` | **Returns the current status of the HedgeDoc instance.**
The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. | diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md index 7ed96944..9169ea4d 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/codimd/server.git codimd-server` +1. Clone the repository with `git clone https://github.com/hedgedoc/server.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 @@ -16,7 +16,7 @@ ## Running the Code -Now that everything is in place, we can start CodiMD: +Now that everything is in place, we can start HedgeDoc: 1. `yarn run build` will build the frontend bundle. It uses webpack to do that. 2. Run the server with `node app.js` @@ -43,7 +43,7 @@ The repository contains two parts: a server (backend) and a client (frontend). most of the server code is in `/lib` and most of the client code is in `public`. ```text -codimd-server/ +hedgedoc-server/ ├── docs/ --- documentation ├── lib/ --- server code ├── test/ --- test suite diff --git a/docs/dev/openapi.yml b/docs/dev/openapi.yml index 4d3e31f6..d32a7ef4 100644 --- a/docs/dev/openapi.yml +++ b/docs/dev/openapi.yml @@ -1,18 +1,18 @@ openapi: 3.0.1 info: - title: CodiMD - description: CodiMD is an open source collaborative note editor. Several tasks of CodiMD can be automated through this API. + title: HedgeDoc + description: HedgeDoc is an open source collaborative note editor. Several tasks of HedgeDoc can be automated through this API. version: 1.6.0 contact: - name: CodiMD on GitHub - url: https://github.com/codimd/server + name: HedgeDoc on GitHub + url: https://github.com/hedgedoc/server license: name: AGPLv3 - url: https://github.com/codimd/server/blob/master/LICENSE + url: https://github.com/hedgedoc/server/blob/master/LICENSE externalDocs: - url: https://github.com/codimd/server/blob/master/docs/dev/api.md + url: https://github.com/hedgedoc/server/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/codimd/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/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.' responses: default: description: Redirect to the created gist (or the GitHub authentication before) @@ -432,7 +432,7 @@ paths: get: tags: - server - summary: Returns the current status of the CodiMD instance. + summary: Returns the current status of the HedgeDoc instance. description: The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. responses: 200: @@ -478,4 +478,4 @@ tags: - name: user description: These endpoints return information about the current logged-in user and it's note history. If no user is logged-in, the most of this requests will fail with either a HTTP 403 or a JSON object containing `{"status":"forbidden"}`. - name: server - description: These endpoints return information about the running CodiMD instance. + description: These endpoints return information about the running HedgeDoc instance. -- cgit v1.2.3