CICE-Consortium / About-Us

Background and supporting information for the CICE Consortium
2 stars 6 forks source link

Add some logos to README.md #17

Closed apcraig closed 3 years ago

apcraig commented 3 years ago

You can see what the resolved README.md looks like here,

https://github.com/apcraig/About-Us/tree/logos

apcraig commented 3 years ago

@dabail10, any comments on the logos placement or looks otherwise? thanks.

dabail10 commented 3 years ago

Thought I had already commented ... the placement is good. I kind of think it might be nice for them to be a bit bigger?

phil-blain commented 3 years ago

I think the placement is a little awkward, as the very first thing in the file (even before the title)...

Maybe we could add an "Award" title or something ?

apcraig commented 3 years ago

@dabail10, good point. I increased the RD100 by a bit and made the sponsor logo more or less full width. I agree this is better. Time to merge, other thoughts?

phil-blain commented 3 years ago

(I'm talking about the R&D logos)

dabail10 commented 3 years ago

I think the placement is a little awkward, as the very first thing in the file (even before the title)...

Maybe we could add an "Award" title or something ?

I agree with Phil. Also, I think the award logos could be even bigger and centered perhaps?

apcraig commented 3 years ago

@phil-blain, I thought about that too, but am not convinced we should create a section just for the RD100 logo. One alternative I was thinking about was moving the RD100 logo to the bottom of the page or to the end of the Overview section. We could even add a sentence at the end of the Overview section like "The Consortium has been recognized for it's successful implementation" and then show the RD100 logo?

phil-blain commented 3 years ago

 We could even add a sentence at the end of the Overview section like "The Consortium has been recognized for it's successful implementation" and then show the RD100 logo?

I think that would be nice. The overview section is not that long, so the R&D logos will still have a good visibility.

apcraig commented 3 years ago

Have a look at the updated version. Words and look OK? https://github.com/apcraig/About-Us/tree/logos

phil-blain commented 3 years ago

But now that I read about it, it seems we can use Markdwon syntax to include images in Markdown files (like our READMEs) wihtout actually embedding the images in the repos. So we could add the R&D logos the the CICE and Icepack READMEs, without adding bloat to the repos: https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images

phil-blain commented 3 years ago

That layout and wording looks good. Maybe we could link directly to https://www.rdworldonline.com/rd-100-2021-winner/cice-consortium/ instead of the full list of winners ?

dabail10 commented 3 years ago

I like the placement and the sentence. I still would prefer it to be a bit bigger and perhaps centered. Also, I thought we discussed having an imagine on the main Consortium page:

https://github.com/CICE-Consortium

I guess we already have an image here.

eclare108213 commented 3 years ago

Looks good - thanks @apcraig for working on it and everyone else for suggestions. My only suggestion is to add to the end of the sentence "... framework for collaboration." e

apcraig commented 3 years ago

I thought about linking to the CICE-Consortium link, and can see going both ways. How do others feel about that?

We could use links to get to the images, but we'd need a place to put them. Dave, how did you upload the RD100 logo to https://user-images.githubusercontent.com/12142035/138731407-4564cf60-da0c-45ab-9bce-9439d5d5837c.png?

As far as I know, we cannot add images to our github pages. We have one image allowed for logos and another potential image allowed for social content, but I see now way to put images on the github pages except in the README. I could be missing something though.

dabail10 commented 3 years ago

In the comment box, I dragged the image and pasted it.

RD100_2021_Logo

apcraig commented 3 years ago

Hmm... reading a bit more, there are tradeoffs between having images in your repo (where the link is robust and the images are revisioned in your repo) vs having them outside (which might save some space). The two images we have on the About-Us page are each 400k. I'm sort of inclined to let the images live in the repo at this point. The size is relatively small. For comparison, the CICE repo is 96M at this point. We could revisit in the future if we do get more and bigger images in our repos? It looks like users do sometimes create issues just to drop an image there and then use that link in README's. That seems a little hokey. We can also reduce the image size quite easily if we really want to. Maybe I'll try to do that now to save a little space.

eclare108213 commented 3 years ago

Another option could be to create a repo just for images (and related resources), and use those links in the repos that are regularly downloaded.

apcraig commented 3 years ago

Also, I tried centered on the RD100 and I think it looks odd. I did center the sponsor logos and that works well. But I think what works for RD100 is the perception that we have a series of badges that recognize achievements, and I think left justified is a better way to present that. But again, happy to change. The one on the web page right now is centered, let me know if you really do think we should do it that way.

phil-blain commented 3 years ago

I agree with Tony, it's more robust to link to places we control. And this here repo (about-us) is not cloned often, so it'a good place to put the images (so Elizabeth, About-Us can act as the image repository :)

So how about this:

Best of both worlds :)

apcraig commented 3 years ago

Great, I think we're converging. I like the idea of trying to use the About-Us images on other READMEs. That should work.

I have updated the new sentence as suggested by @eclare108213.

The final question (maybe) is do we want the RD100 badge to be centered or left justified?

dabail10 commented 3 years ago

I'm fine either way. Thanks for doing this.

eclare108213 commented 3 years ago

Either way is fine. I'd lean left.

apcraig commented 3 years ago

It's back to left. I think this is ready to merge. I'll do that unless I hear some additional comments today. Thanks!

phil-blain commented 3 years ago

@eclare108213, @dabail10 any comment on linking directly to https://www.rdworldonline.com/rd-100-2021-winner/cice-consortium/ instead of the full winner list?

dabail10 commented 3 years ago

I am fine either way. I kind of like the full list to see the company we are in. :)