ESMValGroup / ESMValTool

ESMValTool: A community diagnostic and performance metrics tool for routine evaluation of Earth system models in CMIP
https://www.esmvaltool.org
Apache License 2.0
217 stars 127 forks source link

New (or improved) website #997

Closed valeriupredoi closed 4 years ago

valeriupredoi commented 5 years ago

The tool's website https://www.esmvaltool.org/ looks dated (nice one if we were still in the 1990s :grin: ) in terms of design and if relatively up-to-date with version2 (but not really), I suggest we actually design a nicer-looking website and add a whole lot of nice examples of running the tool and their respective (eye-catching) output plots. I unfortunately don't have neither the experience nor the time to design the website but I can definitely help with suggestions and more practical stuff like examples and their output. What do people think?

valeriupredoi commented 5 years ago

I guess the first question to answer if we want to go ahead with this (at some point in the near future) is if we want this done by ourselves or a third-party web dev; the cheaper way is in-house development ie anyone has an MSc or PhD student who would embark on this?

bouweandela commented 5 years ago

I think we could just make the readthedocs page nicer, that's what most software projects do.

There's also the magic portal, which is fairly nice: https://portal-dev.c3s-magic.eu

valeriupredoi commented 5 years ago

read the docs yes, but we need a nice website that says esmvaltool not C3S bla (that portal is nice indeed, maybe we can use the html source for esmvaltool.org?) - esmvaltool.org is the first gateway for potential new users or developers, it has to be eye-catching and give a nice roadmap for where they want to go next ie read the documentation, go to gitHub, go to the C3S portal etc; it's like you're inviting a whole lot of friends over to your house for a BBQ and the backyard is fantastic but the front of the house looks bombed out

ledm commented 5 years ago

I think we could just make the readthedocs page nicer, that's what most software projects do.

I think that this would be the best way forward. It's time to mothball www.esmvalool.org.

The readthedocs landing page is particularly stark. We should immediately put some kind of header on there. Even a brief subtitle describing ESMValTool before the table of contents would be a great start.

(Yes, I'm back at work now. yay?)

valeriupredoi commented 5 years ago

Yes, we should do it like the iris docs and site, I like that one and has loads of practical examples. But I still think the site should be called esmvaltool.org or dot something so that it's easily found when doing a google search. I volunteer to assemble the practical examples and plug them in the documentation. Also welcome back @ledm :beer:

Dr Valeriu Predoi. Computational scientist NCAS-CMS University of Reading Department of Meteorology Reading RG6 6BB United Kingdom

On Tue, 9 Apr 2019, 17:39 Lee de Mora, notifications@github.com wrote:

I think we could just make the readthedocs page nicer, that's what most software projects do.

I think that this would be the best way forward. It's time to mothball www.esmvalool.org https://www.esmvaltool.org/.

The readthedocs landing page is particularly stark. We should immediately put some kind of header on there. Even a brief subtitle describing ESMValTool before the table of contents would be a great start.

(Yes, I'm back at work now. yay?)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/ESMValGroup/ESMValTool/issues/997#issuecomment-481305860, or mute the thread https://github.com/notifications/unsubscribe-auth/AbpCo8-URVBzxqrI0izu3V6ITut5wrhqks5vfLREgaJpZM4cNxcu .

axel-lauer commented 5 years ago

I took a shot at pimping up our website esmvaltool.org. Here are the results (now including a gallery) waiting for your comments: https://www.esmvaltool.org/esmbeta/

valeriupredoi commented 5 years ago

Woohoo, looks swanky! away at a conference but will have a detailed look when back tomorrow, cheers muchly, Axel! :beer:

Dr Valeriu Predoi. Computational scientist NCAS-CMS University of Reading Department of Meteorology Reading RG6 6BB United Kingdom

On Mon, 1 Jul 2019, 13:50 Axel Lauer, notifications@github.com wrote:

I took a shot at pimping up our website esmvaltool.org. Here are the results (now including a gallery) waiting for your comments: https://www.esmvaltool.org/esmbeta/

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/ESMValGroup/ESMValTool/issues/997?email_source=notifications&email_token=AG5EFI3EWVLOY7G7KD2TBPDP5H4PZA5CNFSM4HBXC4XKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODY6ASGQ#issuecomment-507250970, or mute the thread https://github.com/notifications/unsubscribe-auth/AG5EFI5CNAIKUMTGSEASINLP5H4PZANCNFSM4HBXC4XA .

bouweandela commented 5 years ago

ESMValTool_ what a first time user sees

Maybe we can also try to address the points mentioned on this slide from @ledm's presentation on user friendliness as part of this issue.

Is the wiki still needed? It seems to duplicate the information provided on esmvaltool.org.

Some comments on the new website:

valeriupredoi commented 4 years ago

OK guys now we have a great looking website (kudos to @axel-lauer :beer:) but one suggestion from my UKESM colleagues was to have an active link in the Gallery so that each picture can take you to the bit of documentation that describes the recipe - it's trivial to do it in Markdown but unfortunately I don't speak html that well - can anyone help plss? @axel-lauer @schlunma @mattiarighi :beer:

bettina-gier commented 4 years ago

Change <li class="one_quarter"><a href="./images/perfmetrics_fig_1.png"><img src="./images/perfmetrics_fig_1.png" title=""></a></li> the a href = specifies the link to it, currently they are linking to their own image for full-size view, if you want to switch to recipes, just change the link there to the documentation one? That's if you want it there directly instead of the full-size image. Otherwise add a line below with "produced with recipe fdsgs" and have the recipe a link? Additionally add a target="_blank" inside the tag to make it open in a new tab/window if you want that.

I can probs change it if you want me to, HTML is ez!

valeriupredoi commented 4 years ago

that'd be awesome @bettina-gier Tina :beer: HTML is not ez to me :grin: @axel-lauer could you maybe allow Tina as admin for the site dev?

axel-lauer commented 4 years ago

@bettina-gier I believe you should have access to the source code of the website, which you can find on GitLab at DKRZ here: https://gitlab.dkrz.de/ESMValGroup/esmvaltoolwebsite_v2 If you have trouble, let me know.

bettina-gier commented 4 years ago

Yeah, that's where I copied the part above from. I assume just the regular make a branch and then pull request on gitlab? What do you guys prefer then - change the current link to the full-size pic to documentation link or rather add a "produced with recipe x" link below the images?

axel-lauer commented 4 years ago

I would actually prefer a link below the images, but whatever you think is best. Creating a pull request as usual sounds like the way to go.

bettina-gier commented 4 years ago

Ok! What about images in the gallery from recipes not yet in the version2 master branch? E.g. https://www.esmvaltool.org/images/fig-9-31.png from lauer17_rse? Should I comment those out until they are in version2 and potentially add more from recipes recently added?

axel-lauer commented 4 years ago

I guess best would be to only put images produced with v2 into the gallery.

valeriupredoi commented 4 years ago

cheers guys - ball rolling, me happy :balloon:

axel-lauer commented 4 years ago

Just merged @bettina-gier 's changes into the master branch of the website source code. Thanks for your help! The updates should appear on the website within a few hours from now.

bouweandela commented 4 years ago

The website has been updated some time ago. It would be good to open a new issue if additional changes are needed.