NCAS-CMS / NCAS-CMS/cf-python

SEO (search engine optimization) for the repo & docs

Offen
#35 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Python
Sterne
150
Forks
23
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
2

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Überprüfung der Dokumentations-Build-Einstellungen in conf.py und untersuche anschließend, wie das Repository und die Dokumentation von PyPI und den bestehenden BitBucket-Seiten aus verlinkt sind. Erledigt ist die Aufgabe, wenn das aktuelle Python-3-Repository und die Dokumentation in den Suchergebnissen leichter zu finden sind und die ausgewählten Änderungen anhand dieser Einstiegspunkte verifiziert wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.