sourcegraph/docsite

SEO the docsite: handbook and docs

Aberta

#65 aberto em 8 de dez. de 2020

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Go (9 forks)auto 404
enhancementhelp wanted

Métricas do repositório

Stars
 (71 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

  1. Add frontmatter metadata to all pages - at the very least description: canonical_path:
    twitter_image:

  2. Generate a sitemap file for all of the published pages i.e. for handbook: about.sourcegraph.com/sitemap-handbook.xml for docs: docs.sourcegraph.com/sitemap.xml

Guia do colaborador

Direção de pesquisa
Investigue o codebase do docsite para entender como as páginas são renderizadas e onde adicionar metadados de frontmatter. Para geração de sitemap, procure bibliotecas Go existentes e implemente uma etapa de geração de sitemap.
Pilha de tecnologia
go
Domain
documentationweb dev
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GoWeb development basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70