typelevel/cats-effect

Smarter version numbers in the docs

Open

#523 aperta il 1 mag 2019

Vedi su GitHub
 (23 commenti) (1 reazione) (0 assegnatari)Scala (572 fork)batch import
:books: docsgood first issue

Metriche repository

Star
 (2230 star)
Metriche merge PR
 (Merge medio 21g 23h) (18 PR mergiate in 30 g)

Descrizione

When we release, we have to change the version number twice in the README and once in the tut. The README is currently included directly in the site. sbt-microsite has some automation for the latter, but can't help with the former.

  1. Consider making a more anemic README that drives straight to the site.
  2. Derive the version number in the site when publishing.

Failure to do so was responsible for #252.

Relevant Gitter conversation

Guida contributor

Direzione di ricerca
Studia l'automazione degli aggiornamenti del numero di versione nella documentazione utilizzando sbt microsite e considera la riduzione della duplicazione del README.
Tech stack
scala
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Scalasbt
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60