Browse Source

Update repository name

pull/582/head
Hironsan 4 years ago
parent
commit
357287f3f8
17 changed files with 34 additions and 34 deletions
  1. 2
      .github/ISSUE_TEMPLATE/01-question.md
  2. 2
      .github/ISSUE_TEMPLATE/02-bug.md
  3. 2
      .github/ISSUE_TEMPLATE/03-install.md
  4. 6
      .travis.yml
  5. 4
      app.json
  6. 2
      app/server/templates/base.html
  7. 8
      app/server/templates/index.html
  8. 4
      awsdeploy.yml
  9. 2
      azuredeploy.json
  10. 2
      docs/CODE_OF_CONDUCT.md
  11. 2
      docs/advanced/oauth2_settings.md
  12. 12
      docs/faq.md
  13. 6
      docs/getting-started.md
  14. 4
      docs/index.md
  15. 2
      frontend/components/organisms/layout/TheTopBanner.vue
  16. 6
      mkdocs.yml
  17. 2
      tools/azure.sh

2
.github/ISSUE_TEMPLATE/01-question.md

@ -6,7 +6,7 @@ about: For the question to confirm suspiciously behaviors or feature usage. Plea
How to reproduce the behaviour How to reproduce the behaviour
--------- ---------
<!-- Before submitting an issue, make sure to check the docs and closed issues and FAQ to see if any of the solutions work for you. https://github.com/chakki-works/doccano/wiki/Frequently-Asked-Questions -->
<!-- Before submitting an issue, make sure to check the docs and closed issues and FAQ to see if any of the solutions work for you. https://github.com/doccano/doccano/wiki/Frequently-Asked-Questions -->
<!-- <!--
Include a code example or the steps that led to the problem. Please try to be as specific as possible. --> Include a code example or the steps that led to the problem. Please try to be as specific as possible. -->

2
.github/ISSUE_TEMPLATE/02-bug.md

@ -6,7 +6,7 @@ about: For the bug report or unexpected behavior differing from the docs
How to reproduce the behaviour How to reproduce the behaviour
--------- ---------
<!-- Before submitting an issue, make sure to check the docs and closed issues and FAQ to see if any of the solutions work for you. https://github.com/chakki-works/doccano/wiki/Frequently-Asked-Questions -->
<!-- Before submitting an issue, make sure to check the docs and closed issues and FAQ to see if any of the solutions work for you. https://github.com/doccano/doccano/wiki/Frequently-Asked-Questions -->
<!-- Include a code example or the steps that led to the problem. Please try to be as specific as possible. --> <!-- Include a code example or the steps that led to the problem. Please try to be as specific as possible. -->

2
.github/ISSUE_TEMPLATE/03-install.md

@ -4,7 +4,7 @@ about: For the problem that you faced when installing doccano which none of the
--- ---
<!-- Before submitting an issue, make sure to check the docs and closed issues and FAQ to see if any of the solutions work for you. https://github.com/chakki-works/doccano/wiki/Frequently-Asked-Questions -->
<!-- Before submitting an issue, make sure to check the docs and closed issues and FAQ to see if any of the solutions work for you. https://github.com/doccano/doccano/wiki/Frequently-Asked-Questions -->
How to reproduce the problem How to reproduce the problem
--------- ---------

6
.travis.yml

@ -46,13 +46,13 @@ deploy:
- provider: script - provider: script
script: tools/cd.sh travis-${TRAVIS_BUILD_NUMBER} script: tools/cd.sh travis-${TRAVIS_BUILD_NUMBER}
on: on:
repo: chakki-works/doccano
repo: doccano/doccano
branch: master branch: master
- provider: script - provider: script
script: tools/cd.sh ${TRAVIS_TAG} script: tools/cd.sh ${TRAVIS_TAG}
on: on:
repo: chakki-works/doccano
repo: doccano/doccano
tags: true tags: true
- provider: pages - provider: pages
@ -60,5 +60,5 @@ deploy:
github_token: $GITHUB_TOKEN github_token: $GITHUB_TOKEN
local_dir: site local_dir: site
on: on:
repo: chakki-works/doccano
repo: doccano/doccano
branch: master branch: master

4
app.json

@ -3,8 +3,8 @@
"description": "Open source text annotation tool for machine learning practitioner.", "description": "Open source text annotation tool for machine learning practitioner.",
"keywords": ["Python", "Machine Learning", "Annotation"], "keywords": ["Python", "Machine Learning", "Annotation"],
"website": "https://doccano.herokuapp.com/", "website": "https://doccano.herokuapp.com/",
"repository": "https://github.com/chakki-works/doccano",
"logo": "https://github.com/chakki-works/doccano/wiki/images/doccano.png",
"repository": "https://github.com/doccano/doccano",
"logo": "https://github.com/doccano/doccano/wiki/images/doccano.png",
"success_url": "/", "success_url": "/",
"env": { "env": {
"ADMIN_USER_NAME": { "ADMIN_USER_NAME": {

2
app/server/templates/base.html

@ -73,7 +73,7 @@
</a> </a>
</div> </div>
</div> </div>
<a class="navbar-item" href="https://github.com/chakki-works/doccano">
<a class="navbar-item" href="https://github.com/doccano/doccano">
<span>GitHub</span> <span>GitHub</span>
</a> </a>
{% endif %} {% endif %}

8
app/server/templates/index.html

@ -173,16 +173,16 @@
</h2> </h2>
<ul> <ul>
<li> <li>
<a href="https://github.com/chakki-works/doccano">Documentation</a>
<a href="https://github.com/doccano/doccano">Documentation</a>
</li> </li>
<li> <li>
<a href="{% url 'demo-named-entity-recognition' %}">Live Demo</a> <a href="{% url 'demo-named-entity-recognition' %}">Live Demo</a>
</li> </li>
<li> <li>
<a href="https://github.com/chakki-works/doccano">Source code</a>
<a href="https://github.com/doccano/doccano">Source code</a>
</li> </li>
<li> <li>
<a href="https://github.com/chakki-works/doccano">Contribution</a>
<a href="https://github.com/doccano/doccano">Contribution</a>
</li> </li>
</ul> </ul>
</div> </div>
@ -205,7 +205,7 @@
</div> </div>
<div class="content has-text-centered"> <div class="content has-text-centered">
<p> <p>
<a href="https://github.com/chakki-works/doccano">doccano</a> by
<a href="https://github.com/doccano/doccano">doccano</a> by
<a href="https://github.com/Hironsan">Hironsan</a>. The source code is licensed <a href="https://github.com/Hironsan">Hironsan</a>. The source code is licensed
<a href="http://opensource.org/licenses/mit-license.php">MIT</a>. <a href="http://opensource.org/licenses/mit-license.php">MIT</a>.
<br> <br>

4
awsdeploy.yml

@ -82,10 +82,10 @@ Resources:
- | - |
set +a set +a
- | - |
sudo docker pull chakkiworks/doccano:latest
sudo docker pull doccano/doccano:latest
- > - >
sudo docker run -d --name doccano --env-file /env.list -p 80:8000 sudo docker run -d --name doccano --env-file /env.list -p 80:8000
chakkiworks/doccano:latest
doccano/doccano:latest
- > - >
sudo docker exec doccano tools/create-admin.sh ${ADMIN} ${EMAIL} sudo docker exec doccano tools/create-admin.sh ${ADMIN} ${EMAIL}
${PASSWORD} ${PASSWORD}

2
azuredeploy.json

@ -102,7 +102,7 @@
"dockerImageName": { "dockerImageName": {
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"defaultValue": "chakkiworks/doccano:latest",
"defaultValue": "doccano/doccano:latest",
"metadata": { "metadata": {
"description": "The Docker image to deploy." "description": "The Docker image to deploy."
} }

2
docs/CODE_OF_CONDUCT.md

@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at chakki.works@gmail.com. All
reported by contacting the project team at hiroki.nakayama.py@gmail.com. All
complaints will be reviewed and investigated and will result in a response that complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident. obligated to maintain confidentiality with regard to the reporter of an incident.

2
docs/advanced/oauth2_settings.md

@ -1,4 +1,4 @@
This document aims to instruct how to setup OAuth for doccano. doccano now supports social login via GitHub and Active Directory by [#75](https://github.com/chakki-works/doccano/pull/75). In this document, we show GitHub OAuth as an example.
This document aims to instruct how to setup OAuth for doccano. doccano now supports social login via GitHub and Active Directory by [#75](https://github.com/doccano/doccano/pull/75). In this document, we show GitHub OAuth as an example.
## Create OAuth App ## Create OAuth App

12
docs/faq.md

@ -2,16 +2,16 @@
Following list is ordered by from easy to hard. If you are not familiar with Python development, please consider easy setup. Following list is ordered by from easy to hard. If you are not familiar with Python development, please consider easy setup.
1. [One click deployment to Cloud Service.](https://github.com/chakki-works/doccano#deployment)
1. [One click deployment to Cloud Service.](https://github.com/doccano/doccano#deployment)
* Only you have to do is create an account. Especially [Heroku](https://www.heroku.com/home) does not require your credit card (if free plan). * Only you have to do is create an account. Especially [Heroku](https://www.heroku.com/home) does not require your credit card (if free plan).
* [![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fchakki-works%2Fdoccano%2Fmaster%2Fazuredeploy.json)
* [![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fdoccano%2Fdoccano%2Fmaster%2Fazuredeploy.json)
* [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) * [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
* [![AWS CloudFormation Launch Stack SVG Button](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-external-1.amazonaws.com/cf-templates-10vry9l3mp71r-us-east-1/20190732wl-new.templatexloywxxyimi&stackName=doccano) * [![AWS CloudFormation Launch Stack SVG Button](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-external-1.amazonaws.com/cf-templates-10vry9l3mp71r-us-east-1/20190732wl-new.templatexloywxxyimi&stackName=doccano)
* > Notice: (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or [create one yourself](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair). (2) If you want to access doccano via HTTPS in AWS, here is an [instruction](https://github.com/chakki-works/doccano/wiki/HTTPS-setting-for-doccano-in-AWS).
* > Notice: (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or [create one yourself](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair). (2) If you want to access doccano via HTTPS in AWS, here is an [instruction](https://github.com/doccano/doccano/wiki/HTTPS-setting-for-doccano-in-AWS).
2. [Use Docker](https://docs.docker.com/install/) 2. [Use Docker](https://docs.docker.com/install/)
* Docker doesn't bother you by the OS, Python version, etc problems. Because an environment for application is packed as a container. * Docker doesn't bother you by the OS, Python version, etc problems. Because an environment for application is packed as a container.
* Get doccano's image: `docker pull chakkiworks/doccano`
* Create & Run doccano container: `docker run -d --name doccano -p 8000:80 chakkiworks/doccano`
* Get doccano's image: `docker pull doccano/doccano`
* Create & Run doccano container: `docker run -d --name doccano -p 8000:80 doccano/doccano`
* Create a user: `docker exec doccano tools/create-admin.sh "admin" "admin@example.com" "password"` * Create a user: `docker exec doccano tools/create-admin.sh "admin" "admin@example.com" "password"`
* Stop doccano container: `docker stop doccano` * Stop doccano container: `docker stop doccano`
* Re-Launch doccano container: `docker start doccano` * Re-Launch doccano container: `docker start doccano`
@ -19,7 +19,7 @@ Following list is ordered by from easy to hard. If you are not familiar with Pyt
* **I want to remember you that this is the hardest setup way. You have to install Python/Node.js and type many commands.** * **I want to remember you that this is the hardest setup way. You have to install Python/Node.js and type many commands.**
* [Install Python](https://www.python.org/downloads/) * [Install Python](https://www.python.org/downloads/)
* [Install Node.js](https://nodejs.org/en/download/) * [Install Node.js](https://nodejs.org/en/download/)
* Get the source code of doccano: `git clone https://github.com/chakki-works/doccano.git`
* Get the source code of doccano: `git clone https://github.com/doccano/doccano.git`
* Move to doccano directory: `cd doccano` * Move to doccano directory: `cd doccano`
* Create environment for doccano: `virtualenv venv` * Create environment for doccano: `virtualenv venv`
* Activate environment: `source venv/bin/activate` * Activate environment: `source venv/bin/activate`

6
docs/getting-started.md

@ -5,7 +5,7 @@
First of all, you have to clone the repository: First of all, you have to clone the repository:
```bash ```bash
git clone https://github.com/chakki-works/doccano.git
git clone https://github.com/doccano/doccano.git
cd doccano cd doccano
``` ```
@ -14,7 +14,7 @@ To install doccano, there are three options:
### Option1: Pull the production Docker image ### Option1: Pull the production Docker image
```bash ```bash
docker pull chakkiworks/doccano
docker pull doccano/doccano
``` ```
### Option2: Pull the development Docker-Compose images ### Option2: Pull the development Docker-Compose images
@ -54,7 +54,7 @@ Depending on your installation method, there are two options:
First, run a Docker container: First, run a Docker container:
```bash ```bash
docker run -d --name doccano -p 8000:80 chakkiworks/doccano
docker run -d --name doccano -p 8000:80 doccano/doccano
``` ```
Then, execute `create-admin.sh` script for creating a superuser. Then, execute `create-admin.sh` script for creating a superuser.

4
docs/index.md

@ -34,7 +34,7 @@ Final demo is one of the sequence to sequence tasks, machine translation. Since
Doccano can be deployed to Azure ([Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/) + Doccano can be deployed to Azure ([Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/) +
[PostgreSQL database](https://azure.microsoft.com/en-us/services/postgresql/)) by clicking on the button below: [PostgreSQL database](https://azure.microsoft.com/en-us/services/postgresql/)) by clicking on the button below:
[![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fchakki-works%2Fdoccano%2Fmaster%2Fazuredeploy.json)
[![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fdoccano%2Fdoccano%2Fmaster%2Fazuredeploy.json)
### Heroku ### Heroku
@ -56,4 +56,4 @@ Doccano can be deployed to AWS ([Cloudformation](https://docs.aws.amazon.com/AWS
[![AWS CloudFormation Launch Stack SVG Button](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-external-1.amazonaws.com/cf-templates-10vry9l3mp71r-us-east-1/20190732wl-new.templatexloywxxyimi&stackName=doccano) [![AWS CloudFormation Launch Stack SVG Button](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-external-1.amazonaws.com/cf-templates-10vry9l3mp71r-us-east-1/20190732wl-new.templatexloywxxyimi&stackName=doccano)
> Notice: (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or [create one yourself](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair). (2) If you want to access doccano via HTTPS in AWS, here is an [instruction](https://github.com/chakki-works/doccano/wiki/HTTPS-setting-for-doccano-in-AWS).
> Notice: (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or [create one yourself](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair). (2) If you want to access doccano via HTTPS in AWS, here is an [instruction](https://github.com/doccano/doccano/wiki/HTTPS-setting-for-doccano-in-AWS).

2
frontend/components/organisms/layout/TheTopBanner.vue

@ -23,7 +23,7 @@
large large
outlined outlined
color="white" color="white"
href="https://github.com/chakki-works/doccano"
href="https://github.com/doccano/doccano"
> >
<v-icon left> <v-icon left>
mdi-github-circle mdi-github-circle

6
mkdocs.yml

@ -2,11 +2,11 @@
site_name: 'doccano' site_name: 'doccano'
site_description: 'A Text Annotation tool for Humans' site_description: 'A Text Annotation tool for Humans'
site_author: 'Hiroki Nakayama' site_author: 'Hiroki Nakayama'
site_url: 'https://chakki-works.github.io/doccano/'
site_url: 'https://doccano.github.io/doccano/'
# Repository # Repository
repo_name: 'chakki-works/doccano'
repo_url: 'https://github.com/chakki-works/doccano'
repo_name: 'doccano/doccano'
repo_url: 'https://github.com/doccano/doccano'
# Copyright # Copyright
copyright: 'Copyright &copy; 2018 - 2019 Hiroki Nakayama' copyright: 'Copyright &copy; 2018 - 2019 Hiroki Nakayama'

2
tools/azure.sh

@ -24,7 +24,7 @@ az group deployment create \
adminUserName="${DOCCANO_ADMIN_USERNAME}" \ adminUserName="${DOCCANO_ADMIN_USERNAME}" \
adminContactEmail="${DOCCANO_ADMIN_CONTACT_EMAIL}" \ adminContactEmail="${DOCCANO_ADMIN_CONTACT_EMAIL}" \
adminPassword="${DOCCANO_ADMIN_PASSWORD}" \ adminPassword="${DOCCANO_ADMIN_PASSWORD}" \
dockerImageName="${DOCKER_REGISTRY:-${DOCKER_USERNAME:-chakkiworks}}/doccano:${1:-latest}" \
dockerImageName="${DOCKER_REGISTRY:-${DOCKER_USERNAME:-doccano}}/doccano:${1:-latest}" \
dockerRegistry="${DOCKER_REGISTRY}" \ dockerRegistry="${DOCKER_REGISTRY}" \
dockerRegistryUserName="${DOCKER_USERNAME}" \ dockerRegistryUserName="${DOCKER_USERNAME}" \
dockerRegistryPassword="${DOCKER_PASSWORD}" \ dockerRegistryPassword="${DOCKER_PASSWORD}" \

Loading…
Cancel
Save