NCAS-CMS / NCAS-CMS/cf-python

SEO (search engine optimization) for the repo & docs

Aperta
#35 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Python
Stelle
150
Fork
23
Merge medio
1g 11h
PR unite (30g)
2

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando le impostazioni di build della documentazione in conf.py, quindi verifica come il repository e la documentazione sono collegati da PyPI e dalle pagine BitBucket esistenti. Il lavoro è completato quando il repository Python 3 corrente e la documentazione sono più facili da trovare nei risultati di ricerca e le modifiche scelte sono state verificate rispetto a questi punti di accesso.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.