Office Like Code

O objetivo deste repositório é documentar a metodologia de organização de trabalho e gestão de conhecimento Office Like Code.

Setup :open_book:

O setup windows poderá ser realizado via:

$ git clone git@github.com:o-futuro-ja-comecou/office-like-code.git
$ cd office-like-code
$ python -m venv venv
$ source venv/Scripts/activate
$ pip install -r requirements.txt

O setup linux poderá ser realizado via:

$ git clone git@github.com:o-futuro-ja-comecou/office-like-code.git
$ cd office-like-code
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt

Comando mkdocs serve cria servidor local para visualização, em tempo real, das modificações realizadas no documento.

Publicações de novas versões do documento

Versionamento desta documentação foi criada utilizando a biblioteca mike, conforme orientações material mkdocs. Exemplo de implementação e o repositório de origem também podem ser utilizados como referência[^1]. Actions para publicação da documentação 1.0[^2] foi criado para facilitar o processo de deploy da documentação que está sendo constantemente atualizada.

Para publicação de nova versão necessário atualizar manualmente o comando deploy-mike do arquivo pyproject.toml. Exemplo:

# Versão atual arquivo pyproject.toml
deploy-mike = { cmd = "mike deploy --push --update-aliases 1.0 latest", help = "Publica documento utilizando Mkdocs e versionamento Mike." }

# Nova Versão no arquivo pyproject.toml (cmd)
deploy-mike = { cmd = "mike deploy --push --update-aliases 2.0 latest", help = "Publica documento utilizando Mkdocs e versionamento Mike." }

[^1]: Confira também esta issue utilizado para documentar processo de versionamento.

[^2]: Comando mike set-default --push latest foi executado localmente para garantir que url sempre direcione para a versão mais atual do documento.