Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Commit

Permalink
Merge pull request #115 from unb-mds/documentation/fix-and-finalize-docs
Browse files Browse the repository at this point in the history
Adicionar e finalizar documentação
  • Loading branch information
bitterteriyaki authored Dec 13, 2023
2 parents 1fb5285 + 6272685 commit 7be06a7
Show file tree
Hide file tree
Showing 18 changed files with 205 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/source/reunioes/atas/reuniao-01.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Reunião 01
==========

:bdg-info:`18/09/2023` :bdg-warning:`Sprint 0`
:bdg-info:`18/09/2023`

Resumo
------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/reunioes/atas/reuniao-04.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Reunião 04
==========

:bdg-info:`18/10/2023` :bdg-warning:`Sprint 2`
:bdg-info:`18/10/2023` :bdg-info:`Release 1` :bdg-warning:`Sprint 2`

Resumo
------
Expand Down
6 changes: 4 additions & 2 deletions docs/source/reunioes/atas/reuniao-05.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ Reunião 04
Resumo
------

Esta reunião teve como objetivos nivelar o nivel de conhecimento dos integrantes e retirada
de duvidas.
Esta reunião finalizou a sprint 3, que trouxe conhecimentos e requisitos novos
ao projeto, como os testes unitários. O objetivo foi explicar aos integrantes
que a partir do momento, cada um estaria resposável por fazer os testes para
qualquer código que fosse escrito.
6 changes: 4 additions & 2 deletions docs/source/reunioes/atas/reuniao-06.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ Reunião 06
Resumo
------

Esta reunião teve como objetivos discutir o progresso, anunciar a saida de um
integrante.
Esta reunião teve como objetivos anunciar a saída de um dos integrantes, assim
como discutir quanto às submissões, de que forma seriam julgadas e se todos
concordavam com a aparência do formulário das submissões. Outro objetivo menor
foi explicar o conceito de validadores.
5 changes: 3 additions & 2 deletions docs/source/reunioes/atas/reuniao-07.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ Reunião 07
Resumo
------

Esta reunião teve como objetivos redistribuir as partes de cada integrante e a
redução do prazo para entrega das issues.
Esta reunião tomou como objetivos a redistribuição de papéis, dada a saída
prévia de um dos integrantes. Outra questão a se resolver foi a diminuição do
período das sprints. Reunião rápida, condizente com a metodologia usada.
12 changes: 12 additions & 0 deletions docs/source/reunioes/atas/reuniao-08.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Reunião 08
==========

:bdg-info:`21/11/2023` :bdg-warning:`Sprint 5`

Resumo
------

Esta reunião teve como razão de existência o fechamento da sprint de número 5.
Outro objetivo que se tinha em mente era apresentar o que foi feito, já que
algumas coisas mudaram, como o fato de que um domínio foi comprado para
hospedar o projeto.
12 changes: 12 additions & 0 deletions docs/source/reunioes/atas/reuniao-09.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Reunião 09
==========

:bdg-info:`29/11/2023` :bdg-warning:`Sprint 6`

Resumo
------

Esta reunião foi alusiva à comemoração de dois grandes feitos, a issue de
número 100 e o término do core do projeto. O core do projeto consiste no login
de um *usuário*, criação de um *contest* com *tasks* que aceitam *submissões*,
que por sua vez são *julgadas*.
14 changes: 14 additions & 0 deletions docs/source/reunioes/atas/reuniao-10.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Reunião 10
==========

:bdg-info:`06/12/2023` :bdg-warning:`Sprint 7`

Resumo
------

Esta reunião foi a décima reunião, e última do ciclo. Foram discutidos os
objetivos da *sprint de número 08*, assim como o que foi feito na sprint 07.
Tal discussão se fez necessária dada a drástica mudança de aparência no
formulário de submissão (agora ele se parece mais com um editor de texto),
também foi necessária para que fosse anunciada a chegada de um sistema de
pontuação para os usuários.
3 changes: 3 additions & 0 deletions docs/source/reunioes/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ Atas
atas/reuniao-05
atas/reuniao-06
atas/reuniao-07
atas/reuniao-08
atas/reuniao-09
atas/reuniao-10
3 changes: 3 additions & 0 deletions docs/source/scrum/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ Sprints
sprints/sprint-2
sprints/sprint-3
sprints/sprint-4
sprints/sprint-5
sprints/sprint-6
sprints/sprint-7
11 changes: 11 additions & 0 deletions docs/source/scrum/sprints/sprint-0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ Esta sprint teve como objetivo primário criar o ambiente inicial de
desenvolvimento, a definição do tema, separação dos papéis exercidos pelos
membros do grupo e a iniciação da documentação do projeto.

Missões da sprint
-----------------

Nesta sprints precisávamos nos situar na matéria, metas a bater:

- Começar o estudo das ferramentas
- Decidir quem fará qual papel
- Definir o tema (colocar issues para prof escolher)
- Documentação inicial


Changelog
----------

Expand Down
12 changes: 11 additions & 1 deletion docs/source/scrum/sprints/sprint-1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,18 @@ modelagem incial do projeto. O fim desta sprint era, também, ter uma estrutura
para que possamos trabalhar nas partes cruciais do projeto, como as submissões
e os contests.


Missões da sprint
-----------------

Nesta sprint as metas eram:

- Adicionar/Instalar ferramentas (tanto nos ambientes quanto no github)
- Dar forma à aplicação, bootstrap e outros 'cosméticos'
- Organizar README.md e CONTRIBUTING.md

Changelog
----------
---------

- `Adicionar bootstrap inicial da aplicação (#13) <https://github.com/unb-mds/2023-2-Squad06/pull/13>`_
- `Adicionar barra de navegação ao HTML base (#14) <https://github.com/unb-mds/2023-2-Squad06/pull/14>`_
Expand Down
9 changes: 9 additions & 0 deletions docs/source/scrum/sprints/sprint-2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ Resumo
Esta sprint teve como objetivo finalizar e polir o projeto, visto que esta
sprint antecedeu a primeira release do projeto.

Missões da sprint
-----------------

Nesta sprint as metas eram:

- Apresentar o que fizemos até o presente momento
- Terminar de organizar a documentação
- Desenhar e desenvolver alguns itens avaliativos do plano de ensino

Changelog
----------

Expand Down
11 changes: 11 additions & 0 deletions docs/source/scrum/sprints/sprint-3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ Fase que é focada mais na implementação, portanto o objetivo desta sprint foi
melhorar a aparência da página de registro de usuário e iniciar o
desenvolvimento dos testes unitários (requisito presente no plano de ensino).


Missões da sprint
-----------------

Nesta sprint as metas eram:

- (ir bem na prova de EDA1/EDA2)
- Adicionar partes fundamentais para o funcionamento do projeto



Changelog
----------

Expand Down
18 changes: 14 additions & 4 deletions docs/source/scrum/sprints/sprint-4.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
Sprint 4
========

:bdg-info:`19/11/2023`
:bdg-info:`15/11/2023`

Resumo
------

Nesta sprint, a equipe de desenvolvimento começou a trabalhar na segunda release. As
principais atividades foram o início do desenvolvimento da parte de submissões e a
estilização da página de login para melhor acessibilidade do usuário.
Nesta sprint, a equipe de desenvolvimento começou a trabalhar na segunda
release. As principais atividades foram o início do desenvolvimento da parte de
submissões e a estilização da página de login para melhor acessibilidade do
usuário.

Missões da sprint
-----------------

Nesta sprint as metas eram:

- Adicionar submissões (parte integrante do conceito de Juiz Virtual)
- Estilizar certas páginas
- Alterar e melhorar documentação


Changelog
Expand Down
32 changes: 32 additions & 0 deletions docs/source/scrum/sprints/sprint-5.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Sprint 5
========

:bdg-info:`21/11/2023`

Resumo e Missões da sprint
--------------------------
Nesta sprint o objetivo era continuar a melhorar o projeto, fazendo ele se
parecer cada vez mais com outros juízes virtuais:

- Criando umas das partes mais fundamentais de um Juiz Virtual (as submissões)
- Criando uma página onde o usuário pode ver as informações da conta
- Adicionando LaTeX nas descrições de tasks para renderizar fórmulas

Todos objetivos foram cumpridos com êxito.


Changelog
----------

- `Atualizar tabela de membros da equipe (#88) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/88>`_
- `Criar template formulário de submissão (#80) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/80>`_
- `Adicionar fomulário inicial de submissão (#86) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/86>`_
- `Adicionar página de perfil do usuário (#64) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/64>`_
- `Adicionar página de perfil do usuário (PR) (#82) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/82>`_
- `Corrigir comandos relacionados ao Docker Compose no guia de instalação (#71) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/71>`_
- `Adicionar documentação das sprints (#85) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/85>`_
- `Adicionar arquivos de configuração do Heroku (#87) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/87>`_
- `Logar automaticamente ao criar uma nova conta (#78) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/78>`_
- `Logar automaticamente ao criar uma nova conta (PR) (#81) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/81>`_
- `Renderizar LaTeX em páginas de tasks (#79) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/79>`_
- `Render Latex code with Katex (#84) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/84>`_
34 changes: 34 additions & 0 deletions docs/source/scrum/sprints/sprint-6.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Sprint 6
========

:bdg-info:`29/11/2023`

Resumo e Missões da sprint
--------------------------
Nesta sprint o objetivo era terminar o core do projeto, ao julgar as submissões
de acordo com o que foi planejado (ver informações extras na página de
arquitetura do projeto, aqui, na documentação mesmo). Metas:

- Criar página de submissões
- Integrar a fila de submissões
- Julgar as submissões
- Corrigir pequenos bugs quanto aos contests e tasks.
- Adicionar submissões no painel de administração

Changelog
----------

- `Criar página de submissões (#100) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/100>`_
- `Criar página de submissões (PR) (#101) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/101>`_
- `Integrar sistema de fila (message broker) com a aplicação (#28) <hhttps://github.com/unb-mds/2023-2-JuizVirtual/issues/28>`_
- `Adicionar integração inicial com RabbitMQ e message brokers (PR) (#102) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/102>`_
- `Adicionar resumo da aplicação e motivação no README (#94) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/94>`_
- `Adicionar resumo e motivação da aplicação no README (PR) (#103) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/103>`_
- `Implement test cases feature (PR) (#98) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/98>`_
- `Não permitir que usuário acessem tasks para contests não iniciados ou cancelados (#90) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/90>`_
- `Não permitir que usuário acessem tasks para contests não iniciados ou cancelados (PR) (#99) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/99>`_
- `Implementar página de outros usuários (#91) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/91>`_
- `Implementar página de outros usuários (PR) (#97) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/97>`_
- `Adicionar página de administração para submissões (#92) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/92>`_
- `Adicionar página de administração para submissões (PR) (#93) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/93>`_
- `Serve static files correctly on Heroku (PR) (#89) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/89>`_
26 changes: 26 additions & 0 deletions docs/source/scrum/sprints/sprint-7.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Sprint 7
========

:bdg-info:`06/12/2023`

Resumo e Missões da sprint
--------------------------
Nesta sprint o objetivo era melhorar o que foi feito na sprint passada,
cumprindo as seguintes metas:


- Melhorar a aparência do campo do código no formulário de submissão

- Adicionar pontuação para quando as submissões receberem AC quando julgadas

- Adicionar campo de restrições; afinal, o que é um Juiz Virtual sem *1 < N < 10^6*

Changelog
----------

- `Adicionar suporte a syntax highlighting no formulário de submissão (#95) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/95>`_
- `Adicionar suporte a syntax highlighting no formulário de submissão (PR) (#107) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/107>`_
- `Adicionar feature onde usuários consigam ganhar pontos (#105) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/105>`_
- `Adicionar sistema de pontuação para usuários (#106) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/106>`_
- `Adicionar campo de restrições da task (#96) <https://github.com/unb-mds/2023-2-JuizVirtual/issues/96>`_
- `Add task's constraints field (#104) <https://github.com/unb-mds/2023-2-JuizVirtual/pull/104>`_

0 comments on commit 7be06a7

Please sign in to comment.