Merge pull request #146 from ResidenciaTICBrisa/docsify

Alteração da identidade visual do site da documentação

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Descrição:
+[Descreva brevemente o projeto]
+
+## Tarefas:
+- [ ] Tarefa 1
+- [ ] Tarefa 2
+- [ ] Tarefa 3
+
+## Testes:
+- [ ] Teste 1
+- [ ] Teste 2
+- [ ] Teste 3

docs/README.md

@@ -0,0 +1,29 @@
+<p align="center">
+  <img src="_media/logo.png" width="200" />
+</p>
+
+# T2G8-Plugin-Wordpress
+
+Bem-vindo ao repositório oficial do LGBTQIAPN+ Connect! Nosso projeto tem como principal objetivo conectar empreendimentos e serviços LGBTQIAPN+ friendly com toda a comunidade LGBTQIAPN+. Através dessa plataforma, buscamos promover a inclusão, visibilidade e apoio mútuo dentro da comunidade, fortalecendo laços e ampliando oportunidades para todos. Junte-se a nós nessa jornada rumo a um mundo mais igualitário e acolhedor para todas as identidades de gênero e orientações sexuais!
+
+## Sobre o Projeto
+
+O projeto consiste no desenvolvimento de um plugin de rastreamento de áreas seguras (Safe Zones) para a comunidade LGBT no Brasil. O objetivo principal é fornecer uma plataforma segura e inclusiva que permita aos usuários identificar e compartilhar locais seguros em suas comunidades, como bares, restaurantes, centros comunitários e outros estabelecimentos que sejam acolhedores e respeitosos com a comunidade LGBT. O plugin terá uma interface intuitiva e responsiva, permitindo aos usuários navegar facilmente pelo mapa de Safe Zones, adicionar novos locais e avaliar a segurança e inclusão de estabelecimentos existentes. A integração com uma plataforma de rastreamento de áreas seguras permitirá a comunicação em tempo real e o compartilhamento de informações entre os usuários. O projeto será desenvolvido em quatro releases principais, com atividades como definição de objetivos, pesquisa, desenvolvimento do front-end e back-end, integração com a plataforma de rastreamento, testes e correções, lançamento e promoção do plugin, e monitoramento e manutenção inicial após o lançamento. O objetivo final é criar uma ferramenta poderosa e positiva que contribua para a segurança e bem-estar da comunidade LGBT no Brasil.
+
+## Tecnologias utilizadas
+
+- **Wordpress:** O LGBTQ+ Connect é um plugin criado com o objetivo de atender donos de site ou empresas que utilizam a ferramenta do wordpress.
+
+- **MySQL:** O wordpress utiliza por padrão o MySQL para gerênciamento do banco de dados.
+
+- **JavaScript:** No frontend o javascript se tornou uma ótima opção para lidar com os eventos envolvendo o formulário, além de ser uma técnologia muito utilizada em plugins para wordpress.
+
+- **Leaflet:** Para o georreferenciamento dos locais utilizamos o leaflet, uma biblioteca JavaScript que atende de forma completa os requisitos do nosso projeto.
+
+- **Docker:** Utilizamos o docker para nivelação do ambiente de desenvolvimento entre os membros do time.
+
+## Desenvolvedores
+
+| ![Maximiliano Rohrer Martins Junior](https://avatars.githubusercontent.com/u/160171332?v=4) | ![William Bernardo da Silva](https://avatars.githubusercontent.com/u/124713089?v=4) | ![Igor Brandão Costa](https://avatars.githubusercontent.com/u/111445872?v=4) | ![Gustavo Linhares Lima](https://avatars.githubusercontent.com/u/143884487?v=4) | ![Marcos Vinicius Gündel da Silva](https://avatars.githubusercontent.com/u/85762681?v=4) |
+|:---:|:---:|:---:|:---:|:---:|
+| [Maximiliano Rohrer Martins Junior](https://github.com/Max-Rohrer20) | [William Bernardo da Silva](https://github.com/WillxBernardo) | [Igor Brandão Costa](https://github.com/Punkrig) | [Gustavo Linhares Lima](https://github.com/guslnhm) | [Marcos Vinicius Gündel da Silva](https://github.com/MarcosViniciusG) |

docs/_coverpage.md

@@ -0,0 +1,12 @@
+# LGBTQ+ Connect
+
+> Um plugin para WordPress projetado para simplificar o mapeamento georreferenciado de empreendimentos e serviços voltados para a comunidade LGBTQIAP+.
+
+- BRISA
+- FGA/UnB
+
+[Documentação](README.md)
+[GitHub](https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress)
+<!-- [Google](github.com) -->
+
+![](_media/bg1.png)

docs/_navbar.md

@@ -0,0 +1,14 @@
+<!-- * [Teste](/)
+* [chinese](/atas/) -->
+
+* Atas
+    * [Ata reunião 1](ata-reuniao1.md)
+    * [Ata reunião 2](ata-reuniao2.md)
+    * [Ata reunião 3](ata-reuniao3.md)
+    * [Ata reunião 4](ata-reuniao4.md)
+    * [Ata reunião 5](ata-reuniao5.md)
+<!-- 
+
+* Exemplo 2
+    * [abc](aaa.md)
+    * [bbc](bbb.md) -->

docs/_sidebar.md

@@ -0,0 +1,7 @@
+- [Home](/)
+- [Tutorial](tutorial.md)
+- [Preparando ambiente](preparandoambiente.md)
+- [Wireframes](wireframes.md)
+- [Backlog do produto](backlog.md)
+- [Arquitetura](arquitetura.md)
+- [Storymap](storymap.md)

docs/backlog.md

@@ -1,8 +1,3 @@
----
-hide:
-    - navigation
----
-
 # **Backlog**
 
 Este documento oferece uma visão abrangente do backlog de nosso produto, destacando as funcionalidades, melhorias e tarefas prioritárias que nossa equipe de desenvolvimento planeja abordar. Ele atua como um guia essencial para alinhar nossos esforços com as demandas dos clientes e os objetivos empresariais, facilitando uma gestão eficiente do ciclo de desenvolvimento e garantindo a entrega constante de valor aos usuários finais.

docs/index.html

@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+  <style>
+    .mask{
+      display:none;
+    }
+
+    .anchor{
+      font-weight: bold;
+      font-size:72px;
+    }
+
+    nav{
+      /* background-color: blueviolet; */
+      border-color: blue;
+    }
+
+    /* .anchor span{
+      color:blueviolet !important;
+      font-size:28px;
+    } */
+  </style>
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: '',
+      loadSidebar:true,
+      alias: {
+      '/.*/_sidebar.md': '/_sidebar.md'
+    },
+      subMaxLevel: 2,
+      coverpage: true,
+      onlyCover:true,
+      loadNavbar:true,
+      logo:'/_media/logo.png',
+      themeColor:'#ff006f'
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>

docs/preparandoambiente.md

@@ -1,8 +1,3 @@
----
-hide:
-    - navigation
----
-
 # **Criando ambiente para desenvolvimento**
 
 Os comandos listados a seguir são para dispositivos linux.

docs/releases/release1.md → docs/release1.md

@@ -48,4 +48,3 @@ mínima em estilização de outras funcionalidade do wordpress.
 - Adição de artefatos na documentação: Arquitetura, requisitos, tutorial e documento de releases.
 
 - Atualização de artefatos pois foram levantados novos requisitos com o cliente.
-

docs/releases/release2.md → docs/release2.md

@@ -9,7 +9,7 @@ O objetivo inicial dessa sprint é a implentação de algumas funcionalidades, r
 |---------|---------|
 |Remodelando o banco de dados do projeto|<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/47" target="_blank">#47</a></li>|
 |Adição da página de confirmção|<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/52" target="_blank">#52</a></li>
-|Testando o formulário do plugin pelo Smartphone|<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/57"target="_blank">#57</a></li>|
+|Testando o formulário do plugin pelo Smartphone|<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/57" target="_blank">#57</a></li>|
 |Estudo sobre a implementação de testes| <a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/61" target="_blank">#61</a></li>|
 |Resolvendo bug do template de issue| <a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/62" target="_blank">#62</a></li>|
 |Configuração do ambiente de desenvolvimento (VM)| <a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/63" target="_blank">#63</a></li>|
@@ -78,4 +78,4 @@ O objetivo dessa sprint é o tratamento de algumas funcionalidade (features) adi
 |Refatoração dos arquivos de estilização do projeto |<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/109" target="_blank">#109</a></li>|
 |Atualização nas ações da interface do administrador  |<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/111" target="_blank">#111</a></li>|
 |Ajustes dos botões de ver mais ou menos das buscas |<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/113" target="_blank">#113</a></li>|
-|Adicionando novos botões no painel de administração  |<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/114" target="_blank">#114</a></li>|
+|Adicionando novos botões no painel de administração  |<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/114" target="_blank">#114</a></li>|

docs/releases/release3.md → docs/release3.md

@@ -29,4 +29,3 @@ Nesta sprint, estamos focando na continuação dos trabalhos iniciados na sprint
 | Análise sobre os comportamentos do plugin em dispositivos mobile|<a href="https://github.com/ResidenciaTICBrisa/T2G8-Plugin-Wordpress/issues/128" target="_blank">#128</a></li>|
 
 
-

docs/roadmap.md

@@ -1,8 +1,3 @@
----
-hide:
-    - navigation
----
-
 # **Roadmap**
 
 <iframe width="768" height="432" src="https://miro.com/app/live-embed/uXjVKdx5xvA=/?moveToViewport=-7559,-4388,13554,6489&embedId=661912071924" frameborder="0" scrolling="no" allow="fullscreen; clipboard-read; clipboard-write" allowfullscreen></iframe>  

docs/storymap.md

@@ -1,9 +1 @@
----
-hide:
-    - navigation
----
-
-# **Storymap**
-
-<iframe width="768" height="432" src="https://miro.com/app/live-embed/uXjVKajqbK8=/?moveToViewport=-1862,-1469,4768,2282&embedId=785917292310" frameborder="0" scrolling="no" allow="fullscreen; clipboard-read; clipboard-write" allowfullscreen></iframe>
-
+teste

docs/tutorial.md

@@ -1,27 +1,22 @@
----
-hide:
-    - navigation
----
-
 # **Tutorial para uso do LGBTQ+ Connect**
 
 O LGBTQ+ Connect busca unir locais e serviços amigáveis à comunidade LGBTQ+ em unico só lugar. Fundamentado em princípios essenciais que visam fortalecer a união e o apoio dentro da comunidade, promover um ambiente de convívio seguro e inclusivo, e garantir a promoção ativa da segurança e bem-estar de todos os membros.
 
 ## **Como utilizar o plugin dentro do meu site?**
 
-### **Instalação:**
+# **Instalação:**
 
-#### **Download do arquivo**
+# **Download do arquivo**
 
 - Na raíz do repositório realize o download do arquivo lgbtq_connect.zip, nele esta contido o plugin LGBTQ+ Connect.
 
-#### **Instalação no wordpress**
+# **Instalação no wordpress**
 
 - 1º Na página de adminstração do wordpress acesse o menu de plugins
 - 2º Clique em "Adicionar plugin"
 - 3º Clique em "Enviar plugin"
 - 4º Selecione o arquivo lgbtq_connect.zip
 
-#### **Adicionando o plugin no site**
+# **Adicionando o plugin no site**
 
 No local da sua página onde você deseja adicionar o mapa + formulário adicione o seguinte shortcode: **[lgbtq_connect]**

docs/wireframe.md → docs/wireframes.md

@@ -1,8 +1,3 @@
----
-hide:
-    - navigation
----
-
 # **Wireframes**
 
 ## **Plugin**