sourcegraph/docsite

SEO the docsite: handbook and docs

Ouverte

#65 ouverte le 8 déc. 2020

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Go (9 forks)auto 404
enhancementhelp wanted

Métriques du dépôt

Stars
 (71 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez la base de code du docsite pour comprendre comment les pages sont rendues et où ajouter les métadonnées frontmatter. Pour la génération du sitemap, recherchez les bibliothèques Go existantes et implémentez une étape de génération du sitemap.
Stack technique
go
Domaine
documentationweb dev
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GoWeb development basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70