Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe in README how to build the doc site #19

Open
FrancoisGuillem opened this issue Jan 10, 2017 · 2 comments
Open

Describe in README how to build the doc site #19

FrancoisGuillem opened this issue Jan 10, 2017 · 2 comments
Assignees

Comments

@FrancoisGuillem
Copy link
Contributor

Rajouter dans le README une section "contribute" et expliquer comment reconstruire le site avec la doc

@cderv
Copy link
Collaborator

cderv commented Jan 10, 2017

Hey,

pour le contribute, je pense qu'on peut rajouter une section dessus. Dans le readme, ou bien dans un CONTRIBUTING.md par exemple, ce qui se fait parfois. (En faisant pointer le README dessus). ça dépend de la longueur.

Sinon, que veux tu préciser sur la construction du site ? Tu veux que des contributeurs modifient le site ?
Je pense que la génération du site, une fois mis dans master, devra rester à votre main. On pourrait juste préciser que c'est généré avec pkgdown - ce qui est écrit sur le site d'ailleurs. Du coup, dès qu'une partie du package (Readme, News, documentation functions, vignette, etc...) est modifié, ça sera mis à jour dans le site dès qu'on régénère. Soit manuellement, soit via travis par exemple.

A clarifier, surtout si tu veux que je m'en charge. Thks!

@FrancoisGuillem
Copy link
Contributor Author

Il faudrait juste expliquer que la doc est générer avec pkgdown, mettre un lien vers le package et donner la commande qui permet d'actualiser le site. C'est surtout pour améliorer notre "Bus Factor".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants