jupyterlab / assets

Static assets for JupyterLab extensions

JupyterLab static assets

This repository is serving static assets for JupyterLab in particular it is serving the Jupyter news feed.

The news feed

What is it?

The news feed allow to notify JupyterLab users directly within the application as seen in the below screencast:

The news will be displayed as a toast only once. Then it will be only silently notified (accessible through the notification center). And if the user dismiss the news, it will not see that news any longer.

How does it works?

This repository builds a GitHub pages website that will be published at https://jupyterlab.github.io/assets/.

The website is using Jekyll. And the news feed fetched by JupyterLab is generated by the plugin jekyll-feed; the Atom feed is accessible at https://jupyterlab.github.io/assets/feed.xml.

The feed plugin is parametrized to list only the most recent post (see the configuration).

How to draft a news?

To propose a news, you need to create a new PR that adds a new file in the folder _posts named YYYY-MM-DD-NAME-OF-POST.md. You must replace YYYY-MM-DD with the date of your post and NAME-OF-POST with the name of your post.

The file itself must follow this structure:

---
layout: post
title: "Thanks for using JupyterLab"
date: 2022-11-02 14:00:00 -0000
categories: posts
excerpt: "Big thanks to you, beloved JupyterLab user."
---

# Welcome

Thanks a lot for your interest in JupyterLab.

The header must contain the following entries:

• layout: Set to post
• title: Your post title
• date: The date and time for the post
• categories: Space separated list that must contains posts
• excerpt: Short summary of the post

The notification displayed in JupyterLab will be the concatenation of the title and the excerpt as plain text.

After the header, you can write the post using Markdown formatting.

That part won't be displayed in JupyterLab but the notification will have a link to see it.

You will find additional information in the GitHub documentation.

How to publish a draft news?

Once you have open a draft news in a PR, it will require to be reviewed and approved by at least 2 members of the JupyterLab council.

Once your PR is merged, the post will be the new one to be fetched by JupyterLab users.

You can reach the council by opening a discussion on GitHub.

Security concerns

The notification message will be displayed as text content.