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

"Get started" vignette #57

Closed
krlmlr opened this issue Jun 28, 2018 · 7 comments
Closed

"Get started" vignette #57

krlmlr opened this issue Jun 28, 2018 · 7 comments
Labels
Milestone

Comments

@krlmlr
Copy link
Collaborator

krlmlr commented Jun 28, 2018

Write from scratch, starting from a mental model of a user who knows what CI is.

See the pull request for a rough structure, feel free to edit.

The new README can be a condensed version of the "Getting started" vignette.

@krlmlr
Copy link
Collaborator Author

krlmlr commented Jun 28, 2018

Maybe there's room for multiple vignettes describing each aspect in detail, and the "Get started" vignette contains a rough overview and pointers.?

@maelle
Copy link
Member

maelle commented Jun 28, 2018

Maybe start with motivations, i.e. challenge solved by the package?

By the way in https://ropensci.github.io/dev_guide/ci.html we link to https://juliasilge.com/blog/beginners-guide-to-travis/ maybe you'll want to do that (so that people who don't know CI yet can go read, learn, and come back 😉 )

@krlmlr
Copy link
Collaborator Author

krlmlr commented Jun 28, 2018

I updated the structure, I'll move that to an .Rmd file in a PR very soon.

@krlmlr
Copy link
Collaborator Author

krlmlr commented Jun 28, 2018

Done, happy to take your input there.

CC @lorenzwalthert.

@lorenzwalthert
Copy link

Thanks for the pin @krlmlr. Unfortunately, I don't have time to look into that at the moment in terms of contributing text myself. However, I can review vignettes and add comments once they are ready to merge. Just ping me again for review if something is ready.

@pat-s
Copy link
Member

pat-s commented Jul 15, 2018

Working branch: https://github.com/pat-s/tic/blob/f-new-vignette/vignettes/tic.Rmd

@pat-s pat-s added this to the v1.0.0 (CRAN) milestone Aug 13, 2018
@krlmlr
Copy link
Collaborator Author

krlmlr commented Aug 13, 2018

Closing in favor of #78.

@krlmlr krlmlr closed this as completed Aug 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants