From 9d21da2980f726296bca0d76043900608294a340 Mon Sep 17 00:00:00 2001 From: Odair M <odairmario45@gmail.com> Date: Sun, 16 Apr 2023 20:57:50 -0300 Subject: [PATCH] docs(Repo): change the README.md --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4878561..18b15a1 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,31 @@ -# Template Read the docs -Este repositório server de template para documentação do readthedocs do C3SL -[docs](docs.c3sl.ufpr.br). +# Documentação de suporte dos serviços do C3SL +Este repositório contém a documentação dos serviços do departamento de inormática e do grupo de +pesquisa C3SL + +[suporte](suporte.docs.c3sl.ufpr.br). [[_TOC_]] # Como começar -O primeiro passo é realizar o folk do template e depois clonar o folk. +O primeiro passo é realizar o clone do repositório + +## Clone ssh +O clone por via ssh é recomendado visto que utiliza a chave ssh cadastrada no gitlab, sem precisar +autenticar por senha. + +```bash +git clone git@gitlab.c3sl.ufpr.br:c3sl/c3docs/suporte.git +``` + +## Clone via https +O clone do repositório por https é desencorajado visto que a cada nova alteração é necessário entrar +com as credencias de acesso do gitlab, mas pode ser feito com o comando abaixo: -Após clonar, edite a documentação localizada em `sources` e quando terminar faça push para o gitlab -e link no [docs](docs.c3sl.ufpr.br). +```bash +git clone https://gitlab.c3sl.ufpr.br/c3sl/c3docs/suporte.git +``` +Após clonar, edite a documentação localizada em `sources` e quando terminar faça push para o gitlab. # Organização do repositório O repositório é dedicado a documentação e esta orgazanizado da seguinte maneira: -- GitLab