Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge develop master #8

Merged
merged 83 commits into from
Oct 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
83 commits
Select commit Hold shift + click to select a range
9bf6c52
Fixing Data Annotation Issues
zanussbaum Jul 1, 2021
197d171
move later to copy files in Dockerfile.prod
youichiro Jul 1, 2021
7a34188
fix client-side types about comment as backend returns
ayanamizuta Jul 3, 2021
b150371
add annotation link in commentList page
ayanamizuta Jul 6, 2021
d4cb96f
Add admin interface for AutoLabelingConfigs. Solves #1423
rolisz Jul 6, 2021
0906e78
Sort imports
rolisz Jul 6, 2021
2f47b8c
Return a Response with a status if the task is not yet ready.
rolisz Jul 6, 2021
0243c73
Remove unneeded query
rolisz Jul 8, 2021
62bc03f
Remove unneed import
rolisz Jul 8, 2021
df61e8a
removing debugging statement
zanussbaum Jul 9, 2021
d58cd28
iss1348: fix colors when importing labels
dimidloc Jul 26, 2021
186442a
Updated various dependency and image versions
Jul 21, 2021
5317fef
Python version pinning fix
Jul 22, 2021
abbb662
update cloudformation template to modify the sample env file, now that
daleevans Aug 10, 2021
209bd57
show a check button for annotators
youichiro Aug 18, 2021
7ee3e39
filter by role in the confirm API
youichiro Aug 18, 2021
47831f0
add a property to the ExampleState model
youichiro Aug 18, 2021
263deb2
separate confirm status for each role or user
youichiro Aug 18, 2021
659d96c
fix flake8
youichiro Aug 18, 2021
28052f6
fix TestExampleStateConfirmCollaborative
youichiro Aug 18, 2021
3dbc856
fix isort
youichiro Aug 18, 2021
94ce5e6
move ExampleSerializer tests to test_document.py
youichiro Aug 18, 2021
d122404
add tests
youichiro Aug 18, 2021
e1834c9
Sequence labelling: fix background color in dark mode
colinux Aug 17, 2021
7787295
add confirmed count to statistics api response
youichiro Sep 7, 2021
58c04f7
receive confirmed count value in frontend statistics models
youichiro Sep 7, 2021
bb0bbb2
make progress data per role
youichiro Sep 7, 2021
2db5f00
show progress of each role
youichiro Sep 7, 2021
9e5e870
not display legend of bar-chart
youichiro Sep 7, 2021
d56d742
Increase the allowed max length for uploaded dataset filepath
Sep 15, 2021
0fe4b9d
Bump django from 3.2.4 to 3.2.5
dependabot[bot] Sep 22, 2021
1133ff0
Add EntityEditor
Hironsan Oct 8, 2021
4ec4ca9
Merge pull request #1431 from youichiro/feature/move_later_to_copy_files
Hironsan Oct 12, 2021
8b4b8e7
Merge pull request #1438 from rolisz/autolabeladmin
Hironsan Oct 12, 2021
d96c8da
Merge pull request #1440 from rolisz/download
Hironsan Oct 12, 2021
537b3ab
Merge pull request #1503 from doccano/dependabot/pip/django-3.2.5
Hironsan Oct 12, 2021
f0250df
Merge pull request #1459 from dimidloc/fix-label-import
Hironsan Oct 12, 2021
72f59d8
Merge pull request #1474 from colinux/fix-dark-theme-labelling
Hironsan Oct 12, 2021
db200a8
Merge pull request #1500 from YosuaMichael/increase-dataset-filepath-…
Hironsan Oct 12, 2021
b2b87e4
Merge pull request #1432 from zanussbaum/master
Hironsan Oct 12, 2021
004f39d
Merge pull request #1469 from daleevans/master
Hironsan Oct 12, 2021
8e4e766
Merge pull request #1462 from RSCArt/version-update
Hironsan Oct 12, 2021
1f73ce2
Merge pull request #1433 from ayanamizuta/feature/annotate_from_comme…
Hironsan Oct 12, 2021
583473b
Merge pull request #1442 from rolisz/upload
Hironsan Oct 12, 2021
e90f940
Merge pull request #1473 from youichiro/annotators_check_their_annota…
Hironsan Oct 13, 2021
b67edc2
Merge pull request #1495 from youichiro/update-progress-graph-of-stat…
Hironsan Oct 13, 2021
1977ff1
Fix flake8 warnings
Hironsan Oct 14, 2021
5fc5810
Update Dockerfiles
Hironsan Oct 14, 2021
0489118
Merge pull request #1520 from doccano/fix/CI
Hironsan Oct 14, 2021
c90046b
Merge branch 'master' into enhancement/newSequenceLabelingUI
Hironsan Oct 15, 2021
a12be8e
Add v-annotator
Hironsan Oct 15, 2021
9f99ed2
Update ner demo
Hironsan Oct 15, 2021
511d817
Update sequence labeling page
Hironsan Oct 15, 2021
8ee1b1d
Support RTL in sequence labeling
Hironsan Oct 15, 2021
236e8c4
Update index.md
oztalha Oct 15, 2021
77636c7
Merge pull request #1521 from oztalha/patch-1
Hironsan Oct 16, 2021
f1147e6
Update package
Hironsan Oct 18, 2021
df75f6b
Add fields to SequenceLabelingProject
Hironsan Oct 18, 2021
ae0ae0d
Update serializer in ProjectDetail
Hironsan Oct 19, 2021
070e872
Enable to handle allowOverlapping and graphemeMode option in sequence…
Hironsan Oct 19, 2021
c3940d2
Enable to create project with allowOverlapping and graphemeMode option
Hironsan Oct 19, 2021
45c4e25
Remove unused import
Hironsan Oct 19, 2021
4df832a
Update v-annotator to fix the problem
Hironsan Oct 19, 2021
d7c0e2c
Show shortcut key on menu
Hironsan Oct 19, 2021
dba77db
Add explanation for nested mode
Hironsan Oct 19, 2021
5c50cc0
Add explanation for grapheme mode
Hironsan Oct 19, 2021
ba5f31b
Update shortcut on menu
Hironsan Oct 19, 2021
7f064c4
Update package version
Hironsan Oct 19, 2021
a48907e
Enable to pass grapheme-mode to EntityEditor.vue
Hironsan Oct 20, 2021
4d02700
Add explanation for project creation
Hironsan Oct 20, 2021
15272db
Merge pull request #1511 from doccano/enhancement/newSequenceLabelingUI
Hironsan Oct 20, 2021
08f8a92
Support doccano init on windows
Hironsan Oct 22, 2021
13b9947
Fix cli
Hironsan Oct 25, 2021
811cd5a
Merge pull request #1529 from doccano/fix/1414
Hironsan Oct 25, 2021
4094d9c
Add dependency, fix #1481
Hironsan Oct 26, 2021
647e09b
Merge pull request #1530 from doccano/fix/1481
Hironsan Oct 26, 2021
da24202
Update cli, fix #1408
Hironsan Oct 26, 2021
517824b
Merge pull request #1531 from doccano/fix/1408
Hironsan Oct 26, 2021
22bb21f
Add explanation on create user, close #1410
Hironsan Oct 27, 2021
b851831
Merge pull request #1533 from doccano/enhancement/1410
Hironsan Oct 27, 2021
19b441f
Update faq, close #1496
Hironsan Oct 28, 2021
e5886d7
Merge pull request #1538 from doccano/enhancement/1496
Hironsan Oct 28, 2021
2e5eddd
Merge branch 'master' of https://github.com/ghontolux/doccano into me…
ghontolux Oct 28, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions backend/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import sys

from .app.celery import app
os.environ['DEBUG'] = 'False'
base = os.path.abspath(os.path.dirname(__file__))
sys.path.append(base)
manage_path = os.path.join(base, 'manage.py')
Expand Down
82 changes: 58 additions & 24 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,63 @@
# FAQ

## How to create a user

After running doccano webserver, login to the admin site(in the case of pip installation) via <http://localhost:{port}/admin/>. The below is the example of port `8000` and username `admin`. If you set your own port or username and password on running the server, please change to your one.

![](images/faq/user_creation/login.png)

After login to the admin site, select `Users`:

![](images/faq/user_creation/select_users.png)

Select the ADD USER button in the upper right corner:

![](images/faq/user_creation/select_add_user.png)

After entering the username and password for the new user, select the `SAVE` button:

![](images/faq/user_creation/create_user.png)

Congratulations. Now you are able to log in to doccano as a new user. After logging out of the admin site, try logging in as a new user.

## How to add a user to your project

Note: This step assumes you have already created a new user. See [How to create a user](#how-to-create-a-user) in detail.

After logging in to doccano, select your project. Note that you must be the administrator of the project to add users to the project.

Select `Members` from the left side menu. If you are not the administrator of the project, `Members` will not be displayed.

![](images/faq/add_annotator/select_members.png)

Select the `Add` button to display the form. Fill in this form with the user name and role you want to add to the project. Then, select the `Save` button.

![](images/faq/add_annotator/select_user.png)

Congratulations. Now the new user are able to access the project.

## How to change the password

After running doccano webserver, login to the admin site(in the case of pip installation) via <http://localhost:{port}/admin/>. Note that you need to have a staff permission to login to the admin site. If you don't have it, please ask the administrator to change your password.

![](images/faq/user_creation/login.png)

After login to the admin site, select `Users`:

![](images/faq/user_creation/select_users.png)

Select the user you want to change the password:

![](images/faq/how_to_change_password/user_list.png)

Click `this form` link:

![](images/faq/how_to_change_password/user_page.png)

After showing a form below, change password there:

![](images/faq/how_to_change_password/change_password.png)

## I can't upload my data

Please check the following list.
Expand All @@ -16,30 +74,6 @@ Please check the following list.

**You don't need your real & all data to validate file format. The picked data & masked data is suitable if your data is large or secret.**

## I want to add annotators annotators/annotation approvers

1. Login to [Django Admin](https://djangobook.com/django-admin-site/) (URL: `/admin/`).
2. Add a user to `Users` table (`Add` link).
3. **Logout from Django Admin site.** [You'll face login error without logout of Django Admin site](https://github.com/doccano/doccano/issues/723).
4. Add the user to the project in the member page (`/projects/{project_id}/members`).

## I want to change user's or admin's password

For ordinary user:

1. Login to [Django Admin](https://djangobook.com/django-admin-site/) (URL: `/admin/`).
2. Open `Users` table.
3. Open user you want to change password.
4. In `Password` property, you'll see: `Raw passwords are not stored, so there is no way to see this user's password, but you can change the password using *this form*.` Click `this form` link.
5. Fill the form. Click `CHANGE PASSWORD` button.
6. **Logout from Django Admin site.** [You'll face login error without logout of Django Admin site](https://github.com/doccano/doccano/issues/723).

For the superuser account credentials, you have to set new password in the `docker-compose.dev.yml` and `docker-compose.prod.yml` files:

```yml
ADMIN_PASSWORD: "new_password"
```

## I want to change port number

On production, edit `docker-compose.prod.yml` file: change `80:80` substring in `nginx`/`ports` section to `<your_port>:80`.
Expand Down
Binary file added docs/images/faq/add_annotator/new_user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/faq/add_annotator/select_members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/faq/add_annotator/select_user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/faq/user_creation/create_user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/faq/user_creation/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/faq/user_creation/select_users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
'sqlalchemy>=1.4.7',
'gunicorn>=20.1.0',
'waitress>=2.0.0',
'pydantic>=1.8.2',
'chardet>=4.0.0'
]

setup(
Expand Down