Skip to content

Commit e3da93f

Browse files
committed
addressing review comments
1 parent 20dbe75 commit e3da93f

File tree

2 files changed

+31
-15
lines changed

2 files changed

+31
-15
lines changed

doc/about/user-guidelines.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,31 +45,27 @@ We don't want a single repository to dominate all of the traffic to Binder, so
4545
we've set a maximum limit of concurrent user sessions that point to the same
4646
Binder link. **The maximum number of simultaneous users for a given repo is 100**.
4747
If you think you have a *really* good reason for why this number should be
48-
higher, please [Open an Issue](https://github.com/jupyterhub/mybinder.org-deploy/issues).
48+
higher, please [Open an Issue](https://github.com/jupyterhub/mybinder.org-deploy/issues/new?labels=impact&template=request_resources.md).
4949
to discuss with the community!
5050

5151
## Using mybinder.org as backend for your service
5252

53-
Please do not use mybinder.org as backend for your for-profit service or product.
53+
:::{admonition,warning} A note on for-profit services
54+
Please do not use `mybinder.org` as backend for your for-profit service or product.
5455

55-
The cloud resources consumed by mybinder.org are funded through donations or grants. Because
56-
of this we can not subsidise for-profit products or services by offering free cloud resources to them.
57-
This means we will prevent you from using mybinder.org as a service for your product.
56+
The cloud resources consumed by `mybinder.org` are funded through donations or grants. Because of this we can not subsidise for-profit products or services by offering free cloud resources to them. This means we will prevent you from using `mybinder.org` as a service for your product.
5857

59-
Operating mybinder.org relies on the good will of volunteers and organisations to obtain the
58+
Operating `mybinder.org` relies on the good will of volunteers and organisations to obtain the
6059
resources required to do so. This is easier if we are not seen as supporting for-profit services
6160
that are not a net contributor to the service.
61+
:::
62+
63+
You may be considering using `mybinder.org` as a part of your service or product. We think that is great, and encourage people to experiment with using Binder technology as a part of their tools.
6264

63-
You may be considering using `mybinder.org` as a part of your service or product.
64-
Think that is great, and encourage people to experiment with using Binder technology
65-
as a part of their tools.
65+
However, depending on the size and consistency of traffic being directed at `mybinder.org`, we may restrict your usage of the `mybinder.org` service in order to avoid being overloaded by a single user / organization. This is particularly true for services that trigger many **repository builds**.
6666

67-
However, depending on the size and consistency of traffic being directed at `mybinder.org`,
68-
we may restrict your usage of the `mybinder.org` service in order to avoid being overloaded
69-
by a single user / organization. This is particularly true for services that trigger many **repository builds**.
67+
In general, please be respectful of the Binder Project's limited resources. Do not forget that it has no dedicated funding and runs entirely on donations of cloud resources. If you have a question about this, please [Open an Issue](https://github.com/jupyterhub/mybinder.org-deploy/issues/new?labels=impact&template=request_resources.md).
7068

71-
In general, please be respectful of the Binder Project's limited resources. Do not forget
72-
that it has no dedicated funding and runs entirely on donations of cloud resources.
7369

7470
## Reporting Abuse
7571

doc/conf.py

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,12 @@ def setup(app):
2020
# Add any Sphinx extension module names here, as strings. They can be
2121
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2222
# ones.
23-
extensions = ["sphinx_copybutton", "myst_parser", "sphinx_panels"]
23+
extensions = [
24+
"sphinx_copybutton",
25+
"myst_parser",
26+
"sphinx_panels",
27+
"sphinxext.rediraffe",
28+
]
2429

2530
# Add any paths that contain templates here, relative to this directory.
2631
templates_path = ["_templates"]
@@ -100,6 +105,21 @@ def setup(app):
100105
# so a file named "default.css" will overwrite the builtin "default.css".
101106
html_static_path = ["_static"]
102107

108+
rediraffe_redirects = {
109+
"faq.rst": "using/faq.md",
110+
"about.rst": "about/index.md",
111+
"examples.rst": "examples/examples.md",
112+
"index-repo-reference.rst": "examples/index.rst",
113+
"sample_repos.md": "examples/sample_repos.md",
114+
"index-community.rst": "about/index.md",
115+
"index-getting-started.rst": "introduction.md",
116+
"more-info.rst": "using/faq.md",
117+
"reliability.rst": "about/status.rst",
118+
"status.rst": "about/status.rst",
119+
"user-guidelines.rst": "about/user-guidelines.md",
120+
"using.rst": "using/using.rst",
121+
}
122+
103123
# -- MyST Configuration ------------------------------------------
104124
# See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html#definition-lists
105125
myst_admonition_enable = True

0 commit comments

Comments
 (0)