fga-eps-mds / 2021.2-INDICAA

Este projeto tem como objetivo criar um software para a melhor visualização de informações relacionadas às matérias ofertadas no SIGAA, com o objetivo de melhorar o trabalho da secretaria na volta gradual as aulas.

https://fga-eps-mds.github.io/2021.2-INDICAA-Wiki/

GNU General Public License v3.0

8 stars 7 forks source link

Inserir aba de release notes no git pages #139

Closed Matheuspimentell closed 2 years ago

Matheuspimentell commented 2 years ago

Descrição

Atualmente, o acesso à documentação da release está sendo feito por meio da interface do github. O objetivo desta issue é disponbilizar as release notes no git pages do projeto, visto que as mesmas são parte fundamental da documentção

Tarefas

[x] Criar seção para as release notes.
[x] Inserir a release notes da release 1 (v0.1).

Critérios de aceitação

[x] As release notes devem estar disponíveis no git pages do projeto.
[x] As release notes devem possuir sua própria seção no header do git pages.

guibrbs commented 2 years ago

A seção de release notes foi devidamente criada e nela foi inserido o documento da release 1 e posteriormente será adicionado o da release 2 conforme sua criação. As modificações já foram commitadas seguindo nossa política de branch e seguirá para o PR para a branch develop.

guibrbs commented 2 years ago

As seguintes alterações foram feitas dentro do mkdocs.yml:

- Release Notes:
   - Release 1: release_notes/release1_notes.md

Referenciando a criação de uma nova pasta "release_notes", juntamente com o arquivo em markdown para ser reproduzido dentro do GitHub Pages. As alterações já estão na branch develop e posteriormente seguirão um Pull Request para a main.