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 a date to each notebook #32

Closed
emiliom opened this issue Oct 14, 2021 · 3 comments · Fixed by #56
Closed

Add a date to each notebook #32

emiliom opened this issue Oct 14, 2021 · 3 comments · Fixed by #56
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@emiliom
Copy link

emiliom commented Oct 14, 2021

The new JupyterBook-based IOOS Code Lab looks great!

But one thing that I suggest should be added to each notebook (which was present in the previous IOOS Code Gallery, I think) is a date, making it clear to users when the notebook was developed. That's a useful piece of information to help decide if the code used in the notebook might be old and the packages used may have newer, better features.

Currently, a sharp user will notice that the date is in the notebook file name, in the url. But it'd be better to make that information less subtle. It could go right below the title or at the end next to the Author line.

@MathewBiddle
Copy link
Contributor

This goes back to the template idea we discussed previously.

Per that discussion a template isn't what we need, but maybe we should include some simple recommended pieces to include in a notebook?

Probably sticking something here would be good: https://github.com/ioos/ioos_code_lab/blob/main/CONTRIBUTING.md#building-new-notebooks

@MathewBiddle MathewBiddle self-assigned this Oct 21, 2021
@MathewBiddle MathewBiddle added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 21, 2021
@MathewBiddle
Copy link
Contributor

@ocefpaf we could probably write a simple script to extract the date from the name of the notebook and insert it as a markdown cell. Just wondering if that's the right approach?

Would it be easier/more efficient to do it by hand? There are 34 notebooks to update as of now...

MathewBiddle added a commit that referenced this issue Nov 22, 2021
addressing part of #32.
@ocefpaf
Copy link
Member

ocefpaf commented Nov 22, 2021

@ocefpaf we could probably write a simple script to extract the date from the name of the notebook and insert it as a markdown cell. Just wondering if that's the right approach?

Would it be easier/more efficient to do it by hand? There are 34 notebooks to update as of now...

Rewriting a cell into an existing notebook is not too hard but I never got it to behave as I would like. Usually it generates more changes than it is desirable. Also, we don't want to re-run those notebooks.

TL;DR maybe we can just bite the bullet and add those manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants