NCAS-CMS / NCAS-CMS/cf-python

SEO (search engine optimization) for the repo & docs

Open
#35 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

Currently the latest & greatest i.e. Python 3 / GitHub cf-python (either the repo or the docs) is not easy to access via a search via a search engine. Most initial-page links are relevant & will eventually get you there, but it's still a bit of a windy road to the latest repo or docs, which is concerning not only for visibility but because users might assume only the Python 2 version exists as that is featured in most of the top links.

This is particularly with Google which is what most will use (~70-90% market share from a quick check - via Google search!):

cf-python search

github.com › NCAS-CMS › cf-python doesn't even show up on the first 5 pages.

A bump up the listings may just require a tweak to the conf.py settings for building the documentation to change the title & meta-tags, or something a bit more involved. Or we could instead ensure we link easily to the site or repo from other pages, notably PyPI (third from top), as already in place for the BitBucket pages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation build settings in conf.py, then inspect how the repository and documentation are linked from PyPI and the existing BitBucket pages. Done means the current Python 3 repository and documentation are easier to find in search results, with the chosen changes verified against those entry points.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.