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

NIRISS imaging change to deploy HTML #221

Merged
merged 1 commit into from
Mar 13, 2024
Merged

Conversation

gibsongreen
Copy link
Collaborator

This PR is to work around fork branches and HTML deployment of the niriss-imaging-tutorial notebook PR:
#215

This notebook checklist has been made available to us by the the Notebooks For All team.
Its purpose is to serve as a guide for both the notebook author and the technical reviewer highlighting critical aspects to consider when striving to develop an accessible and effective notebook.

The First Cell

  • The title of the notebook in a first-level heading (eg. <h1> or # in markdown).
  • A brief description of the notebook.
  • A table of contents in an ordered list (1., 2., etc. in Markdown).
  • The author(s) and affiliation(s) (if relevant).
  • The date first published.
  • The date last edited (if relevant).
  • A link to the notebook's source(s) (if relevant).

The Rest of the Cells

  • There is only one H1 (# in Markdown) used in the notebook.
  • The notebook uses other heading tags in order (meaning it does not skip numbers).

Text

  • All link text is descriptive. It tells users where they will be taken if they open the link.
  • All acronyms are defined at least the first time they are used.
  • Field-specific/specialized terms are used when needed, but not excessively.

Code

  • Code sections are introduced and explained before they appear in the notebook. This can be fulfilled with a heading in a prior Markdown cell, a sentence preceding it, or a code comment in the code section.
  • Code has explanatory comments (if relevant). This is most important for long sections of code.
  • If the author has control over the syntax highlighting theme in the notebook, that theme has enough color contrast to be legible.
  • Code and code explanations focus on one task at a time. Unless comparison is the point of the notebook, only one method for completing the task is described at a time.

Images

  • All images (jpg, png, svgs) have an image description. This could be

    • Alt text (an alt property)
    • Empty alt text for decorative images/images meant to be skipped (an alt attribute with no value)
    • Captions
    • If no other options will work, the image is decribed in surrounding paragraphs.
  • Any text present in images exists in a text form outside of the image (this can be alt text, captions, or surrounding text.)

Visualizations

  • All visualizations have an image description. Review the previous section, Images, for more information on how to add it.

  • Visualization descriptions include

    • The type of visualization (like bar chart, scatter plot, etc.)
    • Title
    • Axis labels and range
    • Key or legend
    • An explanation of the visualization's significance to the notebook (like the trend, an outlier in the data, what the author learned from it, etc.)
  • All visualizations and their parts have enough color contrast (color contrast checker) to be legible. Remember that transparent colors have lower contrast than their opaque versions.

  • All visualizations convey information with more visual cues than color coding. Use text labels, patterns, or icons alongside color to achieve this.

  • All visualizations have an additional way for notebook readers to access the information. Linking to the original data, including a table of the data in the same notebook, or sonifying the plot are all options.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@gibsongreen gibsongreen changed the title trivial change to enable HTML deployment workaround NIRISS imaging change to deploy HTM Mar 13, 2024
@gibsongreen gibsongreen changed the title NIRISS imaging change to deploy HTM NIRISS imaging change to deploy HTML Mar 13, 2024
@haticekaratay haticekaratay self-requested a review March 13, 2024 21:23
@gibsongreen gibsongreen merged commit f21658b into main Mar 13, 2024
4 checks passed
@gibsongreen gibsongreen deleted the niriss_feature_branch branch March 13, 2024 21:25
@camipacifici
Copy link
Contributor

Was the table of content updated? I cannot find it in the jupyter book.

@gibsongreen
Copy link
Collaborator Author

Was the table of content updated? I cannot find it in the jupyter book.

Table of Contents is checked as part of the original PR checklist, I am seeing the ToC here, if it needs to be updated let me know and I will take care of it:
https://github.com/spacetelescope/jdat_notebooks/blob/efb562da1b8e68de50cb511acc960747ec12c088/notebooks/niriss_imaging/niriss-imaging-tutorial.ipynb

@camipacifici
Copy link
Contributor

Sorry, I meant the jupyter book table of content. If the notebook is not added there, it will not show with the other rendered notebooks.
I think it is this one: https://github.com/spacetelescope/jdat_notebooks/blob/main/_toc.yml
The notebook should go under NIRISS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants