Add show_banner trait to control the banner display (#6808)

Co-authored-by: Jeremy Tuloup <[email protected]>
Co-authored-by: Rosio <[email protected]>

Author: 3 people

docs/source/frontend_config.rst

@@ -89,3 +89,11 @@ taking various value depending on the page where the configuration is issued.
 ``<section>`` can take various values like ``notebook``, ``tree``, and
 ``editor``. A ``common`` section contains configuration settings shared by all
 pages.
+
+Persisting configuration settings
+---------------------------------
+
+A banner might be shown to users to inform them about news or updates. This 
+banner can be hidden launching the server with the show_banner trait.::
+
+   jupyter notebook --NotebookApp.show_banner=False

notebook/base/handlers.py

@@ -244,6 +244,10 @@ def default_url(self):
     def ws_url(self):
         return self.settings.get('websocket_url', '')
 
+    @property
+    def show_banner(self):
+        return self.settings.get('show_banner', True)
+
     @property
     def contents_js_source(self):
         self.log.debug("Using contents: %s", self.settings.get('contents_js_source',
@@ -530,6 +534,7 @@ def template_namespace(self):
             xsrf_token=self.xsrf_token.decode('utf8'),
             nbjs_translations=json.dumps(combine_translations(
                 self.request.headers.get('Accept-Language', ''))),
+            show_banner=self.show_banner,
             **self.jinja_template_vars
         )
 

notebook/notebookapp.py

@@ -278,6 +278,7 @@ def init_settings(self, jupyter_app, kernel_manager, contents_manager,
             },
             version_hash=version_hash,
             ignore_minified_js=jupyter_app.ignore_minified_js,
+            show_banner=jupyter_app.show_banner,
 
             # rate limits
             iopub_msg_rate_limit=jupyter_app.iopub_msg_rate_limit,
@@ -1171,6 +1172,12 @@ def _default_allow_remote(self):
        """
     )
 
+    show_banner = Bool(True, config=True,
+                        help="""Whether the banner is displayed on the page.
+
+                        By default, the banner is displayed.
+                        """)
+
     open_browser = Bool(True, config=True,
                         help="""Whether to open in a browser after starting.
                         The specific browser used is platform dependent and

notebook/templates/page.html

@@ -136,6 +136,7 @@
 
 <div id="header" role="navigation" aria-label="{% trans %}Top Menu{% endtrans %}">
   <div  id="newsId" style="display: none">
+    {% if show_banner %}
     <div class="alert alert-info" role="alert">
       <div style="display: flex">
         <div>
@@ -153,6 +154,7 @@
         </div>
       </div>
     </div>
+    {% endif %}
   </div>
   <div id="header-container" class="container">
   <div id="ipython_notebook" class="nav navbar-brand"><a href="{{default_url}}