Commit ede7fc53 authored by Jan Heinrich Reimer's avatar Jan Heinrich Reimer
Browse files

Move documentation to admin knowledge base

parent e105972b
......@@ -102,11 +102,12 @@ Writing the answer:
- Consider to split the question. Ask yourself: Could there be people that are just interested in one part of your answer? If so, then split the question but let the answers link to each other.
### How to do data annotation?
For text annotation, use the [Doccano](https://doccano.webis.de/) web service. Here's [how to use it](#how-to-use-doccano).
Doccano can be used for common text annotation tasks such as:
- Text classification (e.g., relevance judgements, [sentiment analysis](https://doccano.webis.de/demo/sentiment-analysis))
- Sequence labelling (e.g., [named entity recognition](https://doccano.webis.de/demo/named-entity-recognition))
- Sequence to sequence (e.g., [translation](https://doccano.webis.de/demo/translation))
Depending on your task, you can use:
- [Doccano](https://doccano.webis.de/) for text annotation. (Here's [how to use it](https://git.webis.de/code-generic/code-admin-knowledge-base/-/blob/master/services/doccano/README.md).)
Doccano supports annotation for:
- Text classification (e.g., relevance judgements, [sentiment analysis](https://doccano.webis.de/demo/sentiment-analysis))
- Sequence labelling (e.g., [named entity recognition](https://doccano.webis.de/demo/named-entity-recognition))
- Sequence to sequence (e.g., [translation](https://doccano.webis.de/demo/translation))
### How to do filenames?
Use **only** English lowercase alphabet, numbers and hyphens in the filename.
......@@ -372,56 +373,7 @@ Install the *Eclipse CVS Client* to use CVS in Eclipse:
If you run into troubles, check [how to fix Eclipse](#how-to-fix-eclipse-).
### How to use Doccano?
The [Doccano](https://doccano.webis.de/) annotation tool is served at https://doccano.webis.de/.
1. [Create user accounts](#how-to-create-users-in-doccano) (including for yourself).
1. [Create a project](#how-to-create-a-project-in-doccano).
1. [Import a dataset](#how-to-import-a-dataset-in-doccano).
1. [Add annotators and moderators](#how-to-add-annotatorsmoderators-to-a-project-in-doccano) to the project.
1. [Start annotating](#how-to-annotate-texts-in-doccano) the dataset.
For more detailed information on how to manage Doccano, you can read its [tutorial](https://github.com/doccano/doccano/blob/master/docs/tutorial.md) and [FAQ](https://github.com/doccano/doccano/blob/master/docs/faq.md).
#### How to create users in Doccano?
1. [Sign in](https://doccano.webis.de/auth) to Doccano as admin.
(The current admin password can be found in the password database next to `webis-organization-notes.txt` in [CVS](https://webis.de/facilities.html?q=webis-organization-notes).)
1. [Add a user](https://doccano.webis.de/admin/auth/user/add/) from the [admin panel](https://doccano.webis.de/admin/).
1. [Repeat](#how-to-create-users-in-doccano) for additional annotators and moderators.
#### How to create a project in Doccano?
1. [Sign in](https://doccano.webis.de/auth) to Doccano.
1. On the [project list](https://doccano.webis.de/projects) page, click on _Create_.
1. Name the project like this: `<year>-<project>-<task>`.
Please stick to this naming convention as there's no option to group projects.
1. Give your project a meaningful description.
1. Choose the annotation type. If you want to restrict users to a single label, select _Allow single label_.
1. Click _Save_.
1. Continue by [adding annotators](#how-to-add-annotatorsmoderators-to-a-project-in-doccano) and [importing datasets](#how-to-import-a-dataset-in-doccano).
### How to import a dataset in Doccano?
1. [Sign in](https://doccano.webis.de/auth) to Doccano.
1. If you haven't, [create a project](#how-to-create-a-project-in-doccano).
1. Open the project from the [project list](https://doccano.webis.de/projects).
1. Go to the _Dataset_ tab, click _Actions_, and select _Import Dataset_.
1. Choose the file type (probably _CSV_) and follow the on screen instructions.
Because of internal limitations, the file name _must not_ exceed a length of 31 characters (see [doccano#1336](https://github.com/doccano/doccano/issues/1336)).
1. Double-check the imported dataset.
#### How to add annotators/moderators to a project in Doccano?
1. [Create the users](#how-to-create-users-in-doccano) you want to add as annotators or moderators.
1. [Sign in](https://doccano.webis.de/auth) to Doccano.
1. Open the project from the [project list](https://doccano.webis.de/projects).
1. Go to the _Members_ tab and click _Add_.
1. Type the annotator username to add to the project.
1. Choose a role and _save_.
1. [Repeat](#how-to-add-annotatorsmoderators-to-a-project-in-doccano) for additional annotators.
#### How to annotate texts in Doccano?
1. [Sign in](https://doccano.webis.de/auth) to Doccano.
1. Open the project from the [project list](https://doccano.webis.de/projects).
1. Click _Start Annotation_.
1. Read the annotation guideline (third icon from the left in the toolbar).
1. Either click the label to annotate or press the label's shortkey on the keyboard.
1. Navigate to the next document using the arrow keys.
See the [usage instructions](https://git.webis.de/code-generic/code-admin-knowledge-base/-/blob/master/services/doccano/README.md).
### How to use Docker?
See our [docker repository and documentation](https://webis.de/facilities.html?q=docker) and the [official tutorial](https://docs.docker.com/get-started/).
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment