sourcegraph/docsite

SEO the docsite: handbook and docs

Offen

#65 geöffnet am 08.12.2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (9 Forks)auto 404
enhancementhelp wanted

Repository-Metriken

Stars
 (71 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

  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

Contributor Guide

Research-Richtung
Untersuchen Sie die Codebasis von docsite, um zu verstehen, wie Seiten gerendert werden und wo Frontmatter Metadaten hinzugefügt werden können. Für die Sitemap Generierung suchen Sie nach vorhandenen Go Bibliotheken und implementieren Sie einen Schritt zur Sitemap Generierung.
Tech Stack
go
Domain
documentationweb dev
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GoWeb development basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70