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

add acknow, cover image, and license in index #71

Merged
merged 6 commits into from
Oct 20, 2022
Merged

Conversation

SaranjeetKaur
Copy link
Collaborator

No description provided.

@SaranjeetKaur SaranjeetKaur added the gsod-2022 Google Season of Docs related task label Sep 16, 2022
@SaranjeetKaur SaranjeetKaur changed the title add acknow add acknow and cover image Sep 16, 2022
@SaranjeetKaur SaranjeetKaur changed the title add acknow and cover image add acknow, cover image, and license in index Sep 16, 2022
@SaranjeetKaur
Copy link
Collaborator Author

some work needed for the cover image

documentclass: book
bibliography: [book.bib]
biblio-style: apalike
link-citations: yes
github-repo: forwards/rdevguide
url: 'TDDO'
cover-image: "img/Rlogo.png"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to create an image of a book cover using the R logo as the main image. See for example the images on https://bookdown.org/ - they are the cover image of the hard copy book. We don't have a hard copy book of course, but you could create a cover page as a PDF to use as an image (e.g. with PDF export from Word or some other program) . Actually the image for "R Programming for Data Science" looks like a self-made example. So you just need the title, the image and R Contribution Working Group as the author.

Consider how it will look on Twitter, e.g. https://twitter.com/straightedge/status/1203515396910772230?s=20&t=3ApdM_TKev1KPzMP3IW7WA - either make the whole image square or center the image vertically on a larger page so that only the R logo shows on the Twitter image.

Copy link
Member

@hturner hturner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to also consider how to add the cover image to the PDF and EPUB. There is some guidance on PDF here: https://stackoverflow.com/a/43057244/173755. It may be easiest to do this first, then split the first page off the compiled PDF to use as cover-image in the YAML for the HTML and EPUB versions.

Note that eventually we want to replace the index with more helpful content for people visiting the guide for the first time. I'm not sure yet if that will be your new Getting Started/Introduction page, or a much shorter version. I'm also not sure if the Acknowledgements should be at the end of this, or elsewhere in the book. It would be good to look at what other people have done to get an idea of good practice. Maybe something like https://www.tidytextmining.com/ with a short welcome explaining what the guide is about and a separate preface ending in acknowledgements? Probably call it something other than Preface though as people may think they can skip it. Getting Started is still good for that part I think.

index.Rmd Outdated Show resolved Hide resolved
index.Rmd Outdated Show resolved Hide resolved
index.Rmd Outdated Show resolved Hide resolved
@SaranjeetKaur
Copy link
Collaborator Author

Some of the comments have been addressed and the remaining ones have been referenced in new open issues. Merging this PR for now.

@SaranjeetKaur SaranjeetKaur merged commit 4ceaa0c into master Oct 20, 2022
@SaranjeetKaur SaranjeetKaur deleted the acknowledgement branch October 20, 2022 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gsod-2022 Google Season of Docs related task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants