typelevel/cats-effect

Smarter version numbers in the docs

Open

#523 ouverte le 1 mai 2019

Voir sur GitHub
 (23 commentaires) (1 réaction) (0 assignés)Scala (572 forks)batch import
:books: docsgood first issue

Métriques du dépôt

Stars
 (2 230 stars)
Métriques de merge PR
 (Merge moyen 21j 23h) (18 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Étudiez l'automatisation des mises à jour du numéro de version dans la documentation à l'aide de sbt microsite et envisagez de réduire la duplication du README.
Stack technique
scala
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Scalasbt
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60