jhudsl / Documentation_and_Usability

A course to cover the basics of creating documentation and tutorials to maximize the usability of informatics tools
https://jhudatascience.org/Documentation_and_Usability/
MIT License
1 stars 0 forks source link

Style #81

Closed carriewright11 closed 3 years ago

carriewright11 commented 3 years ago

Purpose/implementation Section

What changes are being implemented in this Pull Request?

1)adding favicon (assets/ITN_favicon.png and index.Rmd) 2)updating style colors (big-image-itcr.html) 3) added new main image (big-image-itcr.html) 4) adding different button to toc (which includes arrow image) (_output.yml) 5) moving references from about to its own section at end (references.rmd and _bookdown.yml) 6) modifications for section titles(_bookdown.yml) 7) added title slide (01-intro.Rmd) 8) added more credits (About.Rmd) 9) modified index file to include slide info

What was your approach?

Made the course more like mine in a style way. Will update anything missing to the template.

Still confused about why the title is "about". This seems very important to fix as well :/

What GitHub issue does your pull request address?

67

Making our courses more consistent

Tell potential reviewers what kind of feedback you are soliciting.

New Content Checklist

carriewright11 commented 3 years ago

Everything looks pretty similar to mine now. The only issue is the title is "about". Still trying to figure out why, but kinda confused.

carriewright11 commented 3 years ago

I will update the template about style as well. Want to also make it more consistent between naming things with ITN or ITCR.

carriewright11 commented 3 years ago

OK the only major thing I see left for bookdown - is that the images are left aligned and smaller. I made the title image like mine which was with out.width = "100%", would ideally like to add to all images maybe? When I look at the current rendered version they look bigger https://jhudatascience.org/ITCR_Documentation_and_Usability/index.html then when I preview it... maybe that was from when the slides were extra big

carriewright11 commented 3 years ago

Title is now fixed

github-actions[bot] commented 3 years ago

Re-rendered previews from the latest commit:

Updated at 2021-09-28 with changes from 792252bcfe1b10f19a404100ecba273f3e02bda7

cansavvy commented 3 years ago

Thanks for doing this styling stuff!! Only one question. There's these weird squares (You can click on the preview to see for yourself):

Screen Shot 2021-09-27 at 8 33 50 PM
carriewright11 commented 3 years ago

hmmm interesting... the should be arrows for navigation like this: Screen Shot 2021-09-27 at 11 20 07 PM

carriewright11 commented 3 years ago

When I try to render it myself I see the arrows. Perhaps we have another version difference, but it is strange because the current hosted version has the arrows, as well as the bookdown template.

carriewright11 commented 3 years ago

Screen Shot 2021-09-27 at 11 32 39 PM

cansavvy commented 3 years ago

Hmm... Odd. It could be a weird htmlpreview quirk. We can merge and see if it's still there.