ioos / ioos/ioos_code_lab

webpage edits/updates to include deployment version and/or standard ioos.us header/footer

Open
#289 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
16
Forks
15
Avg merge
1h 39m
Merged PRs (30d)
6

Description

Now that we are only publishing releases of the jupyter book, we should include something in the footer that says what release is currently represented on the website.

Probably stick that in the extra_footer:
https://github.com/ioos/ioos_code_lab/blob/6a502e0e174011cfebc7bd42b1eebf17c91d3531/jupyterbook/_config.yml#L48-L56

Thinking about the footer makes me think about the ioos.us work on creating standard header/footers. Andy put together some great documentation on how to do that here. We should explore how to add that to the JupyterBook webpage as well.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with jupyterbook/_config.yml, especially the extra_footer section linked in the issue, and review the ioos.us component-library usage documentation. Determine how to display the current published release in the footer and how the standard ioos.us header/footer can be incorporated. Done means the JupyterBook website shows the release version and the agreed standard header/footer.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.