sourcegraph/docsite

SEO the docsite: handbook and docs

Open

#65 opened on Dec 8, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (9 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (71 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Investigate the docsite codebase to understand how pages are rendered and where to add frontmatter metadata. For sitemap generation, look at existing Go libraries and implement a sitemap generation step.
Tech stack
go
Domain
documentationweb dev
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoWeb development basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70