O projeto Linux Foundation

Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.

Resumo do projeto

Organização de código aberto:
Linux Foundation
Redator técnico:
jaskiratsingh2000
Nome do projeto:
CHAOSS: crie um manual do CHAOSS para toda a comunidade
Duração do projeto:
Duração padrão (3 meses)

Project description

RESUMO DO PROJETO:

Atualmente, os grupos de trabalho da comunidade CHAOSS desenvolveram as próprias formas de trabalhar e documentaram diferentes processos em vários graus. Os grupos de trabalho incluem métricas comuns do WG, WG de diversidade e inclusão, Evolução, risco e valor, que criaram as próprias formas de participação e trabalho e adaptaram diferentes formas de comunicação e cultura de trabalho. Esses grupos de trabalho, de acordo com as métricas, têm diferentes áreas de foco e origens que funcionam para as métricas apropriadas lideram várias pesquisas e desenvolvimentos nas respectivas categorias de trabalho e sabem o caminho certo para liderar pesquisas e desenvolvimentos nas respectivas categorias, mas os processos para iniciantes e colaboradores podem não saber como participar ou seguir o caminho certo para os respectivos trabalhos.

Como resultado disso, as coisas na comunidade CHAOSS não são padronizadas. Portanto, para conhecer o processo certo e os fundamentos básicos da cultura de trabalho em toda a comunidade, o objetivo do manual da comunidade é centralizar informações críticas e padronizar partes delas em todo o projeto CHAOSS. As informações essenciais e a padronização se concentram principalmente nos processos que a CHAOSS usa para que a CHAOSS entenda como a comunidade realiza o trabalho, como os novos usuários podem participar e seguir os fundamentos da comunidade e quais processos e caminhos os novos membros ou membros atuais precisam seguir para aproveitar a liderança na comunidade CHAOSS.

que deve servir como um manual de instruções para membros novos e atuais da comunidade sobre como trabalhar no projeto CHAOSS. Este projeto envolve um componente criativo de coleta e organização de conteúdo para o manual, bem como um componente técnico para definir como representar o manual.

QUAL É A NECESSIDADE DELE?

O Manual da comunidade é um documento que define as principais políticas e procedimentos e descreve a missão, os valores e o trabalho da comunidade.

Este manual apresenta uma introdução e um funcionamento claros para os novos membros da comunidade. Atualmente, o manual da comunidade CHAOSS está disponível no repositório do GitHub e precisa ser reformulado e refatorado com mais informações para iniciantes e usuários da comunidade. Portanto, este manual da comunidade CHAOSS ajudará novos membros e membros da comunidade das seguintes maneiras:

  • Formalização e organização das políticas da comunidade do CHAOSS, com todas elas em um só lugar
  • Comunicar a apresentação, a missão, a visão e a liderança da comunidade
  • Noções básicas sobre as práticas da comunidade do CHAOSS
  • Diretrizes de contribuição
  • Como definir os fluxos de trabalho do projeto
  • Conheça a cultura da comunidade CHAOSS
  • Perguntas frequentes gerais
  • Orientação individual

DESCRIÇÃO DO PROJETO:

O manual da comunidade será dividido em várias "Seções" com informações apropriadas e detalhadas sobre tópicos específicos. As seções podem ser divididas das seguintes maneiras:

  • Introdução
  • O jeito da Comunidade CHAOSS
  • Caminho para a liderança
  • Terminologia
  • Diretrizes de contribuição
    • Desenvolvedor
    • Designer
    • Redator
    • Profissional de marketing
  • Métricas
  • CHAOSScon
  • CHAOSScast
  • Vídeos da reunião
  • Perguntas frequentes gerais
  • Mentoria
    • Google Summer of Code
    • Acolhedor
    • Temporada de Documentos Google

EXIBIÇÕES DETALHADAS DO PROJETO

1) Introdução:

Esta seção vai funcionar como a primeira página do manual da comunidade CHAOSS e abordará os detalhes, a visão geral e o uso do Manual. Confira os itens a seguir:

A.) Ela conterá a mensagem de boas-vindas com uma breve descrição da Comunidade CHAOSS, o que ajudaria a convencer os leitores a ler o manual. Também vou incluir a Colagem de Imagens tirada aqui https://chaoss.community/chaoss-photo-album/, que destaca os vários movimentos dentro da comunidade. B.) A página também conterá os detalhes sobre todas as seções, com uma descrição de uma linha explicando cada seção e os links apropriados. C.) Uso do manual: o uso do manual já existe aqui( shorturl.at/cqQU6 ), mas vou reformular e refatorar o uso atual do manual com uma melhor marcação, incluindo o fluxo do manual(vou incluir como as coisas acontecem quando alguém quer adicionar, remover ou discutir itens relacionados ao manual. Ele pode acompanhar o processo de comunicação para qualquer assunto relacionado ao manual.), Diretrizes do manual(que incluem o uso na comunidade e no escopo), contribuição com o manual ( incluindo como usar o repositório para fazer alterações, fazer PRs, modelo a seguir para fazer alterações no Manual e no Guia de estilo) e compartilhamento de feedback sobre o manual. Em "Compartilhamento de feedback", vou incluir um modelo e diferentes maneiras que os usuários podem acompanhar para informar ou usar problemas do GitLab para recebê-lo.

2.) Do jeito da Comunidade CHAOSS:

O estilo CHAOSS Community será importante para que as pessoas entendam as práticas e as diretrizes da comunidade. Os fluxos de trabalho poderiam enfatizar melhor e delinear as práticas da comunidade da melhor maneira. Essa seção inclui o seguinte:

A.) Valores gerais: descrição de como a sustentabilidade, a abertura e a transparência são tratadas na comunidade CHAOSS. Vou explicar esses valores como os novos usuários ou usuários existentes devem entendê-los e levar em consideração ao trabalhar com a comunidade. B.) Diretrizes da comunidade: incluem informações sobre como participar da Comunidade CHAOSS e seguir os termos básicos. Isso também explicará a cultura de trabalho seguida dentro da comunidade. o que fazer e o que não fazer. Ela incluirá a lista de verificação principal de colaboradores/mantenedores, além de informar outras pessoas sobre como devem trabalhar com mantenedores e quais são as listas de verificação. C.) Grupos de trabalho: a página https://chaoss.community/participate/ (https://chaoss.community/participate/) contém informações sobre os grupos de trabalho, como descrição do WG, link do repositório e informações sobre a reunião. No manual, vou incluir informações sobre como participar dos diferentes grupos de trabalho e entender o processo de avaliação das métricas, entender a cultura de trabalho dos respectivos WGs e como se tornarem os principais colaboradores de diferentes grupos de trabalho.

3.) Caminho para a liderança:

Ganhar liderança em um projeto de código aberto pode ser vital para o sucesso de uma comunidade no mundo comercial. Levando isso em consideração, vou incluir o seguinte:

A.) Liderança técnica: isso incluirá os processos e as responsabilidades dos mantenedores de repositório, redator de documentação e mantenedores de site B.) Liderança em governança: inclui os caminhos para o membro do conselho e o tomador de decisões C.) Lideranças operacionais: incluem o caminho para os gerentes de comunidade

4.) Terminologia:

A terminologia ajudaria a descrever os termos e pertences usados com frequência na comunidade CHAOSS. Além disso, também incluirei as diretrizes de uso da terminologia, como letras maiúsculas, abreviações e palavras a serem evitadas com motivos. Os Termos que serão incluídos são CHAOSS Project, Open Source Health Health, Revisão de código, Grupo de trabalho, Métrica de software de código aberto, Métrica comum, Diversidade e inclusão, Grupo de trabalho de evolução, Grupo de trabalho de risco, Grupo de trabalho de valor, Versão de métrica, Área de foco.

5.) Diretrizes de contribuição:

Esse é o contexto principal de qualquer comunidade de código aberto, já que ela depende das contribuições ou do trabalho voluntário. Isso ajudará todos os novos/usuários que participam da comunidade a entender a necessidade e as diretrizes básicas que precisam seguir. Isso incluirá os seguintes detalhes:

A.) Compreensão do roteiro da comunidade: este tópico fornecerá uma visão geral do roteiro da comunidade CHAOSS, que ajudará os usuários a saber qual caminho ou processo seguir, atribuindo prioridades aos vários trabalhos no projeto CHAOSS. B.) Explique o que é necessário para contribuir, como desenvolvimento, documentação, projeto, testes etc. C. Uma breve visão geral do funcionamento do GitLab D.) Guia de revisores/mantenedores

Esta seção também conterá as “Funções e responsabilidades” para cada categoria de Contribuição, que estão abaixo:

a.) DESIGN: esta subseção incluirá o “Fluxo de trabalho de design de CHAOSS” e as diretrizes de design, que contêm princípios de design, processo e ferramentas usadas que os colaboradores precisam seguir ao contribuir para o campo de design. b.) DEVELOPMENT: contém o guia de contribuição para a base de código. Ele contém os requisitos técnicos, estrutura do projeto, configuração do projeto(Augur, Cregit, GremoireLab) c.) DOCUMENTAÇÃO: isso incluirá recursos de documentação, incluindo ferramentas e guia de estilo. d.) CONTATO: isso incluirá como os colaboradores podem apoiar a comunidade CHAOSS no crescimento da divulgação - Escrever blogs, usar identificadores de redes sociais, organizar encontros e eventos

6.) Métricas

Atualmente, o site da comunidade CHAOSS contém as informações de lançamentos de métricas( https://chaoss.community/metrics/ ) e é mais importante que as pessoas entendam como seguir o processo para disponibilizar o site de métricas nesse site. Esta seção apresenta informações que ajudarão os usuários a conhecer os processos e o funcionamento para que as próprias métricas sejam liberadas.

7.) CHAOSSCON:

As informações sobre o CHAOSScon já estão disponíveis no GitHub( https://github.com/chaoss/governance/blob/master/community-handbook/chaosscon.md) e no site( https://chaoss.community/CHAOSScon-2020-NA/ ), mas faz mais sentido incluir detalhes e informações que explicam os processos e formas de gerenciamento no Manual. No Manual, haverá as seguintes informações:

A.) Detalhes sobre o comitê organizacional: ele explicará os processos de participação no comitê organizador da CHAOSScon B.) Gerenciamento do processo de chamada para propostas: inclui gerenciar o registro do autor, o envio de propostas e documentação, a revisão e o processo de aprovação. C.) Gerenciamento e publicação do programa CHAOSScon D.) Como gerenciar material de publicidade e marketing E.) Como lidar com propostas de patrocínio e fundos incluindo pacotes

8.) CHAOSScast:

As informações sobre o CHAOSScast estão disponíveis em https://github.com/chaoss/governance/blob/master/community-handbook/chaosscast.md (em inglês) e serão incluídas no Manual com alguns detalhes adicionais, como participação, comitê organizacional, publicidade e materiais de marketing.

9. Vídeos da reunião:

Ele incluirá todos os vídeos da reunião e a descrição, como participantes, programação, etc. que aconteceram no passado e estão disponíveis no YouTube.

10. Perguntas frequentes gerais:

Ela apresentará perguntas gerais comuns que são feitas na comunidade e ajudará novos membros e membros existentes da comunidade a responder a algumas delas.

11.) Google Summer of Code:

Esta seção conterá informações sobre o Google Summer of Code, os Critérios de qualificação e informações sobre como as pessoas podem participar da comunidade CHAOSS no Google Summer of Code. Esta seção também conterá o Modelo de proposta que as pessoas podem usar para redigir suas propostas, funções e responsabilidades. O documento também vai conter informações que ajudam os membros atuais da comunidade a conhecer o processo para se tornarem mentores e administradores da organização.

  1. Contato:

Esta seção contém informações sobre o contato, os critérios de qualificação e como as pessoas podem participar da comunidade CHAOSS no app.Isso inclui as funções e responsabilidades, incluindo o processo para se tornar o administrador da organização e os mentores.

  1. Temporada de Documentos Google:

Esta seção contém informações sobre o GSoD, os critérios de qualificação e como as pessoas podem participar da comunidade CHAOSS no GSoD. Ela inclui as funções e responsabilidades, incluindo o processo para se tornar administrador e mentores da organização.

RESULTADO ESPECÍFICO DO PROJETO:

Os manuais têm um papel importante em qualquer comunidade. Da mesma forma, este manual do CHAOSS para toda a comunidade vai resultar em uma documentação mais organizada e detalhada para a comunidade do CHAOSS. Os novos participantes e os membros que já fazem parte da comunidade entenderiam os conceitos básicos e o funcionamento da comunidade CHAOSS com facilidade. Além disso, este manual mostra os vários processos e caminhos para diferentes culturas de trabalho na comunidade CHAOSS.

DETALHES TÉCNICOS:

Proponho o uso da plataforma Gitbook para manter o manual, porque ele é um projeto colaborativo e fácil de usar para que as equipes trabalhem com mais eficácia e eficiência. Alguns recursos da plataforma GitBook:

  • WYSIWYG: editor de texto eficiente e bonito
  • Markdown: suporte eficiente e produtivo de atalhos de markdowns
  • Incorporação avançada: incorpora conteúdo externo da Web, como vídeos, snippets de código, artigos, músicas e muito mais
  • Painéis para roteiristas: tenha um painel inteligente para escritores que suporta a edição visual
  • Rascunhos: crie novas alterações e colabore de forma assíncrona
  • Comentários do suporte: discuta e revise o rascunho das mudanças
  • Acompanhe o histórico de escrita: acompanhe tudo. Analisar e reverter alterações
  • Insights: também oferece insights que acompanham o tráfego, a classificação e a qualidade do conteúdo
  • GitHub Sync: como manter o fluxo de trabalho e continuar sincronizando os documentos com o GitHub
  • Personalização da marca: domínios personalizados, logotipos personalizados, fontes, cores, temas, cabeçalho etc.

Estas são algumas imagens que dão uma ideia da plataforma

  • shorturl.at/GNQR4
  • shorturl.at/gATZ8
  • shorturl.at/qrE57
  • shorturl.at/rFRX6
  • shorturl.at/eyLW1
  • shorturl.at/rwHS8

-- Onde o Manual será hospedado?

O Manual será hospedado no próprio GitBook, onde o GitHub oferece um mecanismo adequado para domínio personalizado, erro comum e SEO.

Domínios personalizados: se a comunidade CHAOSS quiser hospedá-la no domínio personalizado, ela será exibida da seguinte forma: docs.chaoss.community. A organização é necessária apenas para criar qualquer subdomínio que ela queira ter. Para configurar o domínio da organização, acesse as configurações dela na plataforma Gitbook. Exemplo de imagem: shorturl.at/GNQR4

Os espaços do GitBook são disponibilizados pela nossa própria CDN com o HTTPS ativado por padrão. Os certificados são emitidos pela LetsEncrypt

Domínios compatíveis:

  • Subdomínio: www.example.com
  • Domínio personalizado: docs.example.com

-- Como sincronizar o Gitbook com o GitHub para que a edição possa ser feita nas duas plataformas de forma eficaz?

A integração com o GitHub é muito fácil de usar: se alguém alterar algum conteúdo no GitBook, as edições serão enviadas para um repositório do GitHub. Por outro lado, as confirmações enviadas para um repositório do GitHub são importadas no GitBook.

Configure a integração do GitHub:

  • No seu espaço na plataforma GitBook, clique na guia de integrações > GitHub.
  • Autorizar o acesso do GitBook à sua conta do GitHub vinculada à organização
  • Acesse o GitHub da sua organização e crie um repositório de “HandBook”, por exemplo, caoss-handbook
  • Agora, selecione o repositório chamado chaoss-handbook que você quer conectar com a opção de autorização na plataforma GitBook.

Quando essas etapas forem concluídas, o GitBook adicionará um webhook ao repositório do caoss-handbook, que permitirá buscar o conteúdo em cada alteração no repositório. Quando você faz mudanças no GitBook, um novo comentário é enviado.

Pronto! Qualquer pessoa pode continuar editando com o GitBook ou o repositório do GitHub.

-- Como editar páginas na plataforma GitBook?

Qualquer pessoa que queira editar qualquer coisa na plataforma GitBook precisa participar dela com um link de convite ou participação. O GitBook oferece suporte à edição visual, em que os usuários podem escrever diretamente nas páginas.

Um rascunho é uma versão editável do conteúdo do usuário que pode ser acessada apenas pelos escritores e é criada automaticamente quando você começa a escrever (primeira letra no editor, criação de uma nova página, upload de uma imagem etc.).

As alterações feitas em um rascunho são adequadas a ele, o que permite que os usuários contribuam no mesmo documento com outros membros simultaneamente sem criar conflitos. Isso é o que chamamos de edição assíncrona e resolução de conflitos.

A primeira versão do rascunho nem sempre está pronta para ser publicada imediatamente. Use "Salvar" quando quiser continuar seu trabalho mais tarde ou se o conteúdo ainda não estiver pronto para ser "mesclado".

Quando terminar de editar, você pode mesclar seu rascunho. O conteúdo que você escreveu ou as mudanças feitas estarão disponíveis para os membros da sua equipe e/ou serão públicos.

Exemplos de imagem: shorturl.at/gATZ8 e shorturl.at/qrE57

-- Estrutura do conteúdo:

Sumário: cada espaço pode ter quantas páginas forem necessárias para escrever sua documentação. Todas essas páginas ficam visíveis no lado esquerdo da tela, no que chamamos de Índice. No sumário, você pode gerenciar suas páginas: criar novas páginas, grupo de páginas, adicionar links externos, adicionar uma variante, importar documentos externos, como sites ou arquivos Markdown (.md ou .markdown), HTML (.html), Microsoft Word (.docx).

Página inicial: é a página inicial ou a raiz da documentação e funciona basicamente como o mestre de todas as páginas da documentação. Como ela é a entrada principal da sua documentação e do seu espaço, não é possível mover esta página, excluí-la, ter crianças ou fazer parte de um grupo.

Páginas: uma página tem um título, uma descrição opcional na parte superior do editor. Você pode escrever e adicionar qualquer tipo de conteúdo a ela.É possível aninhar páginas arrastando e soltando uma abaixo de outra. Os elementos filhos de uma página ficam ocultos, mas podem ser recolhidos.

Links externos: essas entradas são links externos e não têm conteúdo no editor. Sua principal função é vincular a sites externos.

Variantes: você pode criar um conteúdo alternativo para sua documentação criando uma variante. Isso pode ser útil para documentar várias versões de uma API, uma biblioteca ou traduções.

Exemplo de imagem: shorturl.at/eyLW1 e shorturl.at/rFRX6

-- Como o Manual será apresentado no lado do cliente?

O manual da comunidade do Chaoss poderá ser acessado com um subdomínio https://docs.chaoss.community e terá as seguintes características no lado do usuário:

  • Manual do Mattermost: https://handbook.matitet.com/
  • Linux Foundation Community Bridge Docs: https://docs.linuxfoundation.org/docs/ E muito mais

CRONOGRAMA DO PROJETO:

1) Fase de vínculo comunitário (17 de agosto a 13 de setembro)

A.) Semanas 1 a 4:

  • Discutir o projeto com mentores
  • Pesquisar e coletar as informações necessárias para as várias seções do projeto, fazer perguntas esclarecedoras à comunidade
  • Esclareça com a comunidade qual plataforma usar no manual (sugiro o GitBook) e faça a configuração.
  • Contribuir com problemas nos documentos

2.) Fase de desenvolvimento de documentos (14 de setembro a 30 de novembro)

A.) Semana 5 (14 de setembro a 20 de setembro)

  • rascunho” Introdução

B.) Semana 6 (21 de setembro a 27 de setembro)

  • Crie um rascunho da seção "The CHAOSS Community Way" (O jeito da comunidade CHAOSS)

C.) Semana 7 (28 de setembro a 4 de outubro)

  • Elabore a seção "Caminho para a liderança"
  • Elabore a seção "Terminologia"

D.) Semana 8 (5 de outubro a 11 de outubro)

  • Elabore o roteiro da comunidade
  • Rascunho de diretrizes de contribuição de design

E.) Semana 9 (12 de outubro a 18 de outubro)

  • Seção Desenvolvimento de rascunho

F.) Semana 10 (19 de outubro a 25 de outubro)

  • Diretrizes da seção "Redação e contato"

G.) Semana 11 (26 de outubro a 1o de novembro)

  • Seção "Rascunho de métricas"
  • Criar rascunho da seção CHAOSScon

H.) Semana 12 (2 de novembro a 8 de novembro)

  • Elabore a seção da reunião

  • Crie um rascunho de perguntas frequentes gerais da comunidade

    I.) Semana 13 (9 de novembro a 15 nov)

  • Rascunho das diretrizes de GSoC

J.) Semana 14 (16 a 22 de novembro)

  • Rascunho das diretrizes de contato

K.) Semana 15 (23 a 29 de novembro)

  • Intervalo; polimento e melhoria de todos os documentos

3.) Fase de avaliação (30 de novembro a 5 de dezembro)

A.) Semana 16:

  • Elaborar um relatório de projeto
  • Preencher a avaliação do projeto

INTERAÇÕES DA COMUNIDADE

1) Envolvimento e discussões com a comunidade

Bem, navego na comunidade CHAOSS desde abril de 2020 e participo de várias discussões com membros da comunidade e com os mentores específicos do meu projeto( Georg Link e Armstrong Foundjem). Uma discussão que despertou maior interesse dos membros da comunidade foi “Propondo o Gitbook como uma plataforma para hospedar o manual da comunidade”. Ela pode ser encontrada na conversa da lista de e-mails do arquivo CHAOSS com o nome “Proposta do Gitbook como plataforma para hospedar o manual da comunidade”. Também participei das chamadas semanais da comunidade, o que me ajudou a fazer atualizações.

2.) Como você vai coletar as informações necessárias para este projeto?

Como este projeto requer a configuração do manual da comunidade, as informações que devem ser acessadas nele sejam coletadas e discutidas com os membros da comunidade. Conforme propusei minha linha do tempo acima, para que eu possa discutir e coletar as informações necessárias durante meu período de conexão com a comunidade.

Vou pesquisar sobre as várias seções de acordo com o CHAOSS e manter as conversas na lista de e-mails. Vou tentar fazer perguntas esclarecedoras com meus mentores e com a comunidade, dependendo dos requisitos.

Para ter discussões concisas, também participarei de chamadas semanais.

3.) Como você propõe que manterá a comunidade informada sobre seu progresso e quaisquer problemas ou perguntas que possa ter ao longo do projeto?

Para ter flexibilidade e transparência, tentarei me comunicar por meio da discussão da lista de e-mails para tirar minhas dúvidas.

Vou compartilhar meu progresso semanal em uma postagem do blog com a documentação scrum e os desafios enfrentados, que serão compartilhados na própria lista de e-mails da comunidade para alcançar um público maior dentro da organização de código aberto.

Também participo de chamadas semanais da comunidade para oferecer sugestões e discussões adequadas sobre os principais problemas.

Também estou planejando criar um quadro Trello com as tarefas semanais disponíveis. Os mentores podem usar esse quadro para entender de forma clara e concisa os problemas e recursos atuais.

4.) O que você fará se ficar preso em seu projeto e seu mentor não estiver por perto?

Acredito que a função do mentor é orientar os alunos na direção certa, não explicar a eles cada etapa do caminho. A pesquisa e a implementação do projeto são responsabilidades exclusivas do estudante. Tendo isso em mente, só tentarei obter ajuda do meu mentor como último recurso.

No entanto, se o mentor não estiver disponível/ocupado no momento em que eu precisar de ajuda, vou compartilhar o problema que estou tendo na comunidade do CHAOSS. Tenho certeza de que alguém será capaz de me ajudar com qualquer desafio que eu me deparar. Também vou compartilhar o problema em fóruns on-line/comunidades de desenvolvimento, como o dev.to.

Além disso, eu gostaria de participar de todas as chamadas semanais para receber ajuda na comunidade CHAOSS, a fim de tirar minhas dúvidas.