Skip to content

Commit

Permalink
Adiciona índice para a documentação
Browse files Browse the repository at this point in the history
  • Loading branch information
Joffily Ferreira committed Aug 20, 2019
1 parent c2ece29 commit 870c6b3
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

É uma ferramenta desenvolvida para automatizar os registros de DOI pelas coleções que adotam a métodologia SciELO. Por meio do DOI Manager é possível gerenciar novos depósitos, re-depositar, contabilizar custos e buscar informações sobre sucesso e falha de depósitos passados.

## Documentação

Para mais informações sobre a ferramenta acesse o [índice da documentação](docs/README.md).

## Métodos de instalação

Expand Down Expand Up @@ -65,4 +68,4 @@ O DOI Manager **não é** auto suficiente ao depositar os registros DOI, é nece

Ao configurar o ambiente de `deploy` da aplicação é recomendável que se configure agendadores de execução para o comando `processing_export_doi`.

**ATENÇÃO** :warning: O DOI Manager é dependente dos dados vindos do [`ArticleMeta`](https://github.com/scieloorg/articles_meta/), a execução do comando `processing_export_doi` só deverá acontecer após o `ArticleMeta` estar **ATUALIZADO**. Para mais detalhes sobre *datas e horários de atualização* consulte a pessoa responsável pela infraestrutura.
**ATENÇÃO** :warning: O DOI Manager é dependente dos dados vindos do [`ArticleMeta`](https://github.com/scieloorg/articles_meta/), a execução do comando `processing_export_doi` só deverá acontecer após o `ArticleMeta` estar **ATUALIZADO**. Para mais detalhes sobre *datas e horários de atualização* consulte a pessoa responsável pela infraestrutura.
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Índice da documentação

* [Módulos e serviços para o ambiente de produção](production-services.md)
53 changes: 53 additions & 0 deletions docs/production-services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Serviços para Produção

Para o funcionamento da aplicação, é necessário configurar:

- Banco de Dados: responsável por armazenar os registros dos documentos
- Exportdoi: responsável por consultar os documentos processados no Article Meta, de acordo com os parâmetros informados, e armazená-los na Base de Dados. É executado através da linha de comando::

```shell
processing_export_doi [-h] [--issns_file ISSNS_FILE] --collection
COLLECTION [--from_date FROM_DATE]
[--until_date UNTIL_DATE]
[--date_range DATE_RANGE]
[--logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
[--sentry_handler SENTRY_HANDLER]
[issns [issns ...]]

Argumentos:
issns ISSN\'s seperados por espaço

Argumentos opcionais:
-h, --help Exibe este texto de ajuda
--issns_file ISSNS_FILE, -i ISSNS_FILE
Path completo para um arquivo TXT com a lista de ISSNs
a serem exportados
--collection COLLECTION, -c COLLECTION
Acrônimo da coleção a ser exportada
--from_date FROM_DATE, -f FROM_DATE
Data inicial de processamento dos documentos
(processing_date), no formato ISO no formato YYYY-MM-DD,
para a exportação.
Ex.: 2019-07-20
--until_date UNTIL_DATE, -g UNTIL_DATE
Data final de processamento dos documentos
(processing_date), no formato ISO no formato YYYY-MM-DD,
para a exportação.
Ex.: 2019-07-20
--date_range DATE_RANGE, -r DATE_RANGE
Número de dias anteriores à data corrente para a data de
processamento dos documentos a serem exportados. Este
sobrescreverá qualquer definição dos argumentos from_date
e until_date.
--logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}, -l {DEBUG,INFO,WARNING,ERROR,CRITICAL}
Logging level
--sentry_handler SENTRY_HANDLER
DSN do Sentry. Esta opção tem precedência sobre a
configuração da variável de ambiente SENTRY_HANDLER
```
- Dashboard: interface WEB desta aplicação
- Celeryworker: responsável por enfileirar as tarefas de depósito no CrossRef
- Celeryworker-dispacher: responsável por executar as tarefas enfileiradas pelo Celeryworker. Este não recebe o status do depósito de documentos.
- Celeryworker-releaser: responsável por consultar o status do depósito de documentos no CrossRef.
- Redis: armazena as filas

0 comments on commit 870c6b3

Please sign in to comment.