Merge pull request #258 from choldgraf/institutions

Add support binder page

Author: minrk

doc/_static/custom.css

@@ -1,3 +1,15 @@
+:root {
+    --sd-color-primary: #579aca;
+    --sd-color-secondary: #f5a252;    
+}
+
+/* Header */
+i.fa.fa-heart {
+    color: #e66783;
+}
+
+/* Text elements */
+
 div.body p.caption {
     font-size: 1.2em;
 }

doc/contribute.md renamed to doc/about/contribute.md

@@ -16,3 +16,7 @@ information.
 ## Contribute to the codebase of the Binder Project
 
 Most of the code used by the Binder Project is not hosted in this repository. If you'd like to contribute to the code, check out [the JupyterHub Team Compass guide to contributing](https://jupyterhub-team-compass.readthedocs.io/en/latest/team/skills.html).
+
+## Contribute financial or cloud resources to the project
+
+See our [supporting mybinder.org page](support.md) for more information.

doc/about/about.rst renamed to doc/about/faq.rst

@@ -1,8 +1,6 @@
-.. _about:
-
-======================
-About ``mybinder.org``
-======================
+================================
+Frequently Asked Questions (FAQ)
+================================
 
 mybinder.org is a deployment of the BinderHub technology. It is run as a public
 service for those who'd like to share their interactive repositories publicly.
@@ -11,6 +9,7 @@ It is used by the Binder project to demonstrate the "cutting edge" of its techno
 This page explains some of the teams and organizations behind mybinder.org, as
 well as common questions about using mybinder.org
 
+.. _about:
 
 About ``mybinder.org``
 ======================
@@ -40,7 +39,7 @@ If you publish work that uses Binder, please consider citing the
 
 Here is a citation that you can use:
 
-.. code-block:: raw
+.. code-block::
 
    Jupyter et al., "Binder 2.0 - Reproducible, Interactive, Sharable
    Environments for Science at Scale." Proceedings of the 17th Python
@@ -59,21 +58,10 @@ the `Binder team <https://jupyterhub-team-compass.readthedocs.io/en/latest/team.
 For more information about the BinderHubs behind ``mybinder.org``, see
 :doc:`The BinderHub Federation <federation>`.
 
-Who pays for mybinder.org?
+Who supports mybinder.org?
 --------------------------
 
-The service at mybinder.org is provided by a federation of BinderHub deployments
-that are maintained by several members and organizations in the Binder community.
-For information about who runs and pays for these deployments, see :doc:`The BinderHub Federation <federation>`.
-
-Is there dedicated funding for the Binder Project?
---------------------------------------------------
-
-The Binder Project currently has no dedicated funding (beyond the time and hardware costs
-provided by :doc:`The BinderHub Federation members <federation>`).
-
-In 2017 the Binder Project received a 1-year grant from the
-`Moore Foundation <https://figshare.com/s/e9d0ad7bdc4e405cccfa>`_.
+See :doc:`support`.
 
 What technology runs mybinder.org?
 ----------------------------------
@@ -298,8 +286,8 @@ documentation for how to customize the user environment.
 Other tools in the Binder ecosystem
 -----------------------------------
 
-.. panels::
-   :card: text-center
+.. card::
+   :text-align: center
 
    Google Chrome extension:
    `Open in Binder <https://carreau.github.io/posts/32-open-with-binder-chrome.html>`_.

doc/about/index.md

@@ -6,7 +6,9 @@ This is a collection of pages about the Binder service running at mybinder.org.
 :maxdepth: 1
 
 user-guidelines
-status
-about
+faq
+support
+contribute
 federation
+status
 ```

doc/about/status.rst

@@ -1,5 +1,5 @@
-Status of ``mybinder.org``
-==========================
+Status page
+===========
 
 This page displays several graphics that give an idea for the current
 status of the `mybinder.org <https://mybinder.org>`_ service. You can find

doc/about/support.md

@@ -0,0 +1,74 @@
+# Support the project
+
+The Binder community gets support from many different people and in many different forms.
+This page describes the kinds of support that Binder receives, as well as how you can support the Binder project.
+
+:::{admonition} Who supports mybinder.org?
+
+- [The mybinder.org landing page](https://mybinder.org) has list of organizations that financially support mybinder.org.
+- {external+tc:doc}`team` has a list of personnel that support the project.
+
+:::
+
+## Our major costs
+
+In addition to developing and maintaining the many open source tools built by this project, we also have a few extra costs:
+
+- **Cloud expenses for mybinder.org**: The service at mybinder.org serves tens of thousands of sessions each week, each of which run in the cloud.
+  We pay for this infrastructure via donations of credits and money from the community.
+- **Personnel to operate mybinder.org**: Running a heavily-used and complex cloud service requires expertise in cloud infrastructure development and operation.
+  We receive in-kind contributions from several individuals and organizations to help us sustain these operations.
+
+## Donate to our cloud operations fund
+
+The easiest way to support the mybinder.org team is to provide a financial contribution to our cloud operations fund.
+This is administered by [NumFocus](https://numfocus.org) and is used to pay for the cost of developing, operating, and paying the cloud bill for Binder.
+
+```{button-link} https://numfocus.salsalabs.org/donate-to-binder
+:color: primary
+
+Donate funds to mybinder.org
+```
+
+## Provide cloud credits for mybinder.org
+
+If you are a cloud provider, or have credits that can be donated to run mybinder.org's infrastructure, please send us an email about making a donation of cloud infrastructure.
+
+```{button-link} mailto:[email protected]
+:color: primary
+
+Donate cloud credits to mybinder.org
+```
+
+## Operate cloud infrastructure with us
+
+The Binder team operates a variety of BinderHub deployments across many cloud providers via [the BinderHub Federation](federation.md).
+If you have cloud infrastructure, or the skills to operate cloud infrastructure, we invite you to join the BinderHub Federation by offering to assist with running a BinderHub deployment.
+Even better, you can offer to [deploy and operate a new BinderHub Federation member](federation/joining)!
+
+```{button-link} https://github.com/jupyterhub/team-compass/issues/new/choose
+:color: primary
+
+Reach out about operating infrastructure
+```
+
+## Help with our open source efforts
+
+Finally, all of the techology behind mybinder.org is built by an open community.
+We welcome any kind of contributions and support.
+You can find many ways to contribute to the Binder community, codebase, and services at [](../contribute.md).
+
+## Attribution for team members
+
+We wish to recognize the contributions that individuals and organizations make on behalf of Binder.
+For this reason, we define a few key contribution areas below, and explicitly recognize these contributions in our mybinder.org pages.
+
+- *mybinder.org federation members* - Institutions that deploy, fund, and staff their own BinderHub in the federation.
+- *mybinder.org partner institutions* - Institutions that employ individuals that operate any hubs in the mybinder.org federation (if not full federation members).
+- *mybinder.org major supporters* - Institutions that provide significant financial resources or credits for any hubs in the mybinder.org federation ("significant" is defined as anything greater than $10,000 annually).
+
+## Previous grants and major support
+
+- From 2019 through 2021, `gke.mybinder.org` was supported by cloud credits from [Google Cloud](https://cloud.google.com/).
+- In 2017 the Binder Project received a 1-year grant from the
+`Moore Foundation <https://figshare.com/s/e9d0ad7bdc4e405cccfa>`_.

doc/about/user-guidelines.md

@@ -1,4 +1,4 @@
-# `mybinder.org` Usage Guidelines
+# Fair use guidelines
 
 This page details some guidelines and policies that we follow at ``mybinder.org``.
 

doc/conf.py

@@ -6,11 +6,6 @@
 from pathlib import Path
 import requests
 
-
-def setup(app):
-    app.add_stylesheet("custom.css")
-
-
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -23,7 +18,7 @@ def setup(app):
 extensions = [
     "sphinx_copybutton",
     "myst_parser",
-    "sphinx_panels",
+    "sphinx_design",
     "sphinxext.rediraffe",
     "sphinx.ext.intersphinx",
 ]
@@ -54,7 +49,8 @@ def setup(app):
 release = "0.1b"
 
 intersphinx_mapping = {
-    "repo2docker": ("https://repo2docker.readthedocs.io/en/2021.03.0/", None),
+    "r2d": ("https://repo2docker.readthedocs.io/en/latest/", None),
+    "tc": ("https://jupyterhub-team-compass.readthedocs.io/en/latest/", None),
 }
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -95,6 +91,13 @@ def setup(app):
     "google_analytics_id": "UA-101904940-3",
     "github_url": "https://github.com/jupyterhub/binder",
     "twitter_url": "https://twitter.com/mybinderteam",
+    "icon_links": [
+        {
+            "name": "Support",
+            "url": "https://mybinder.readthedocs.io/en/latest/about/support.html",
+            "icon": "fa fa-heart",
+        }
+   ]
 }
 
 html_context = {
@@ -109,9 +112,11 @@ def setup(app):
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+html_css_files = ["custom.css"]
 
 rediraffe_redirects = {
     "about.rst": "about/index.md",
+    "contribute.md": "about/contribute.md",
     "examples.rst": "examples/examples.md",
     "index-repo-reference.rst": "examples/index.rst",
     "sample_repos.md": "examples/sample_repos.md",
@@ -130,8 +135,6 @@ def setup(app):
     "deflist",
 ]
 
-panels_add_bootstrap_css = False
-
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.