search

ioos / notebooks_demos

Notebook demonstrations and examples
https://ioos.github.io/notebooks_demos/
MIT License
19 stars 19 forks source link

Jupyter{Book} Enhancement #423

Closed lohithmunakala closed 3 years ago

lohithmunakala commented 3 years ago

This enhancement is based on the https://github.com/ioos/notebooks_demos/issues/417 (issue).

A new footer section has been added and the logo has been made bigger.

The homepage looks like this now

image

MathewBiddle commented 3 years ago

Just pulled this over and built locally. Looks like the colab link has something wrong. If I try to launch Colab, as shown in the screen shot below, I get a link to the local notebook not a colab notebook. image

Here's the link I get: file:///github/ioos/notebooks_demos/blob/master/jupyterbook/content/Code%20Gallery/data_access_notebooks/2016-10-12-fetching_data.ipynb

I think _config.yml needs to be updated, https://github.com/lohithmunakala/notebooks_demos/blob/36c6bcb7cb1cb93392d65599fbbf5391110511f2/jupyterbook/_config.yml#L77

MathewBiddle commented 3 years ago

@mwengren see the screen shot in the first comment. Is that footer sufficient for alignment with ioos.us sites?

IMHO it's not very pretty, but it relays the information you requested. I think just having the ioos.noaa.gov, Facebook, Twitter, and Contact Us links would suffice.

mwengren commented 3 years ago

Looks good to me. We should probably remove the Copyright though as I don't think that's the intention and everything we produce should be public domain. We may have that elsewhere in our ioos.github.io sites as well and it should be removed there as well if so (separate issue).

MathewBiddle commented 3 years ago

@lohithmunakala can we remove the copyright?

lohithmunakala commented 3 years ago

Just pulled this over and built locally. Looks like the colab link has something wrong. If I try to launch Colab, as shown in the screen shot below, I get a link to the local notebook not a colab notebook. image

Here's the link I get: file:///github/ioos/notebooks_demos/blob/master/jupyterbook/content/Code%20Gallery/data_access_notebooks/2016-10-12-fetching_data.ipynb

I think _config.yml needs to be updated, https://github.com/lohithmunakala/notebooks_demos/blob/36c6bcb7cb1cb93392d65599fbbf5391110511f2/jupyterbook/_config.yml#L77

I didn't add the Colab link in the _config.yml as weren't sure - initially - if we were going to need it. Just added it in this - https://github.com/ioos/notebooks_demos/pull/423/commits/15186f06d48483e3b32eef400c59bd3e931c5e3a - commit. The option will now direct you to Colab.

lohithmunakala commented 3 years ago

@lohithmunakala can we remove the copyright?

@MathewBiddle, There isn't a way we can remove the term "Copyright". This is what gets displayed when we remove anything from the copyright string in the config file.

image

Or we can do something like this, which is the default

image

Which would we better?

MathewBiddle commented 3 years ago

There might be a workaround, see this https://github.com/executablebooks/jupyter-book/issues/582#issuecomment-629371516

MathewBiddle commented 3 years ago

@mwengren is it a deal breaker if we can't remove the copyright? Looks like it could get messy.

lohithmunakala commented 3 years ago

There might be a workaround, see this executablebooks/jupyter-book#582 (comment)

I did check this out, but as the static files that are generated are after we run the notebook, it would mess with the automatic publication of the website. Because we use GitHub Actions to build the notebook, this would get overwritten every time we make a change to the repo - triggering the GA to create a new set of static files.

We would probably need to automate editing out each of the CSS files and then publish the web page.

mwengren commented 3 years ago

Ok, if it's too cumbersome to remove the Copyright, then we can leave as is. It seems like the JupyterBook library should allow the option to customize that wording though, might be a good PR to submit to them if you know how it could be done.

MathewBiddle commented 3 years ago

@ocefpaf once those changes are made, I'm okay with merging. Unless you want to compile #413 in here and update the various references to Notebook gallery and Data Demo Center to IOOS Code Lab.

MathewBiddle commented 3 years ago

@lohithmunakala can we rename this markdown to nanoos.md

https://github.com/lohithmunakala/notebooks_demos/blob/jupyterbook_enhancement/jupyterbook/content/Video_Demo_Markdown/noos.md

lohithmunakala commented 3 years ago

The header for the file inside? Or do we want the name of the file to be changed too.

MathewBiddle commented 3 years ago

both

MathewBiddle commented 3 years ago

Looks good! I'll merge.