Pular para conteúdo

📖 Guia de Uso: Base de Conhecimento Lupa NOC

Bem-vindos à nova estrutura de documentação do NOC Lupa! Agora a nossa base é leve, versionada via GitLab e otimizada para busca instantânea.

Este documento é o seu roteiro completo para acessar e alimentar a nossa nova base de conhecimento. Siga cada passo com atenção para configurar o seu acesso.

1. VS Code vs Obsidian

Característica VS Code (Editor de Código) Obsidian (Cérebro Digital)
Foco Editar código (.php, .sql, .bash). Conectar ideias e procedimentos (.md).
Navegação Explorador de pastas clássico. Links bidirecionais e busca instantânea.
Visualização Sintaxe técnica e Terminais. Legibilidade e Gráfico de Conexões (Graph View).
Workflow Produzir (Rodar scripts/comandos). Pensar (Organizar históricos e projetos).

Qual usar e quando? * Use o VS Code quando: For ajustar um .htaccess, editar o footer.php de um cliente ou rodar comandos de terminal no Debian. * Use o Obsidian quando: For registrar o histórico de atendimento, planejar a migração de um servidor ou consultar um procedimento de rede sob pressão.

2. O que são estas ferramentas?

  • GitLab: É o nosso Cofre Central. É um servidor que guarda cada versão do que você escreve. Nada se perde.
  • Obsidian: É a sua Bancada de Trabalho. Um programa focado em velocidade que organiza tudo em arquivos de texto simples (.md).
  • Git: É o Transportador. É a ferramenta em segundo plano que leva o que você faz no seu PC para o Cofre no servidor.

3. Passo 1: Preparando o seu Computador (Antes de tudo)

Antes de baixar a base, você precisa se identificar para o "Transportador".

  1. Abra o PowerShell no seu Windows.
  2. Digite os comandos abaixo (um por vez) para o servidor saber quem é você nos logs:
    • git config --global user.name "Seu Nome Completo"
    • git config --global user.email "seu.email@lupahosting.com.br"
  3. Para não ter que digitar senha toda hora, ative o guardador de credenciais:
    • git config --global credential.helper manager

4. Passo 2: Criando sua "Chave Mestra" (Token)

O GitLab exige uma chave de segurança para o seu PC se conectar ao cofre. Não use sua senha comum.

  1. Acesse o GitLab da Lupa pelo navegador.
  2. Clique na sua Foto (Avatar) no canto superior direito > Preferences.
  3. No menu esquerdo, clique em Access Tokens.
  4. Clique em Add new token:
    • Token name: Obsidian-Meu-PC
    • Scopes (Obrigatório): Marque api, read_repository e write_repository.
  5. Clique em Create personal access token.
  6. ⚠️ COPIE O CÓDIGO AGORA: Guarde essa senha em um local seguro. Ela só aparece esta vez e será sua senha no Passo 3.

5. Passo 3: Baixando a Base (O Clone)

Agora vamos trazer os manuais para o seu computador de forma definitiva.

  1. Crie uma pasta no seu PC (ex: C:\Documentacao_Lupa).
  2. No GitLab, entre no projeto Base de Conhecimento Lupa NOC.
  3. Clique no botão azul Code e copie o link em Clone with HTTPS.
  4. No PowerShell dentro da sua pasta recém-criada, digite:
    • git clone [LINK_QUE_VOCE_COPIOU]
  5. Login: O Windows pedirá seu usuário do GitLab e a Chave Mestra (Token) que você criou no Passo 2.

6. Passo 4: Configurando o Obsidian & Plugins Obrigatórios

Para manter a compatibilidade total entre a edição local e a visualização via web pelos técnicos externos no celular, configure o aplicativo exatamente com os parâmetros abaixo:

  1. Abra o Obsidian, clique em Open folder as vault e selecione a pasta clonada.
  2. Vá em Configurações > Arquivos & Links:
  3. Pasta padrão para salvar novos arquivos: Altere para "Na pasta especificada abaixo".
  4. Local da pasta de anexos: Digite precisamente 99%20-%20Anexos.
  5. Formato para links novos: Altere para "Caminho relativo do arquivo".
  6. Usar [[Wikilinks]]: Certifique-se de manter ATIVADO (Roxo).

Instalação do Conversor de Imagens

  1. Vá em Configurações > Plugins não oficiais (Community Plugins) > Explorar.
  2. Busque e instale o plugin: Paste Image Rename and Convert (do desenvolvedor yiaos). Clique em Ativar.
  3. Acesse as opções do plugin recém-instalado e garanta que a opção Convert PNG to WebP está ATIVADA.

Configuração do Git Automatizado

  1. Vá em Configurações > Plugins não oficiais > Git.
  2. Na seção Automatic, configure os seguintes tempos de sincronismo:
  3. Auto commit interval (minutes): 10
  4. Auto push interval (minutes): 10
  5. Auto pull interval (minutes): 10
  6. Role até a seção Pull e ative a opção Pull on startup (Isso baixa as atualizações da equipe assim que você abre o app).

7. Boas Práticas e Fluxo de Imagens (Ctrl + V)

  • Nomenclatura Automática: Sempre que você colar um print (Ctrl + V) em uma nota de cliente, o Obsidian exibirá um pop-up perguntando o nome do arquivo. Digite um nome claro e técnico (ex: pfsense-wan-embraseg).
  • O que o sistema faz sozinho: O plugin converterá o arquivo para .webp (reduzindo o tamanho em até 70% para abrir rápido no celular), moverá a mídia para a pasta 99%20-%20Anexos e o Obsidian atualizará o link interno da nota calculando a distância relativa correta automaticamente.

8. Possíveis Problemas

Como configuramos a sincronização automática no Passo 4, você dificilmente verá erros. Mas, caso a internet caia ou ocorra um conflito, veja como resolver:

Erro de conflito (Fetch First / Rejected):

! [rejected] main -> main (fetch first) error: failed to push some refs...

Isso significa apenas que outro técnico enviou atualizações para o GitLab enquanto você editava localmente. Para resolver de forma forçada, abra o terminal do Linux/PowerShell na pasta do projeto e execute a nossa linha de contingência geral:

git fetch origin && git reset --soft origin/main && git add . && git commit -m "Sincronismo geral NOC" && git push origin main

Se o Git travar no meio de um processo e disser que existe um arquivo .lock, remova-o manualmente rodando no PowerShell/Terminal: rm -f .git/index.lock

Após isso, o Obsidian voltará a sincronizar normalmente.