Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SEO the docsite: handbook and docs #65

Open
aileenrose opened this issue Dec 8, 2020 · 0 comments
Open

SEO the docsite: handbook and docs #65

aileenrose opened this issue Dec 8, 2020 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@aileenrose
Copy link

aileenrose commented Dec 8, 2020 •
edited

  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
@aileenrose aileenrose added enhancement New feature or request help wanted Extra attention is needed labels Dec 8, 2020
@aileenrose aileenrose mentioned this issue Dec 8, 2020
Open
@jhchabran jhchabran mentioned this issue Sep 22, 2021
Merged
jhchabran added a commit that referenced this issue Sep 27, 2021
@jhchabran
Add support for more metadata fields (#75)
4ea4ea8 
Add more fields to metadata struct, enabling use front matter to set open graph tags for SEO. It partly addresses #65.

Design-wise, all new fields are hardcoded in the metadata struct. No error will be raised if they aren't present. But any key not referenced by the Metadata struct will raise an error.

A plain old meta field in the front matter could have been a good choice, but my primary concern with that is that have no way to ensure that those fields are properly populated, which would result in believing that the pages are properly annotated while they are not, which is difficult to spot. There are ways to fix this, but this requires additional work.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aileenrose