Skip to content

Commit 0b7824a

Browse files
committed
Remove master from docs
1 parent cbe530b commit 0b7824a

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ You are assumed to have a modern version of [Python](https://www.python.org/),
283283
1. Install `helm` - the Kubernetes package manager.
284284

285285
```bash
286-
curl -sf https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
286+
curl -sf https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
287287
```
288288

289289
Here are the [official installation instructions](https://helm.sh/docs/intro/install/).

doc/conf.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@
5757
# You can specify multiple suffix as a list of string:
5858
source_suffix = [".rst", ".md"]
5959

60-
# The master toctree document.
61-
master_doc = "index"
60+
# The root toctree document.
61+
root_doc = "index"
6262

6363
# Set the default role so we can use `foo` instead of ``foo``
6464
default_role = "literal"
@@ -107,7 +107,7 @@
107107
html_context = {
108108
"github_user": "jupyterhub",
109109
"github_repo": "binderhub",
110-
"github_version": "master",
110+
"github_version": "main",
111111
"doc_path": "doc",
112112
}
113113

@@ -145,15 +145,15 @@
145145
# (source start file, target name, title,
146146
# author, documentclass [howto, manual, or own class]).
147147
latex_documents = [
148-
(master_doc, "BinderHub.tex", "BinderHub Documentation", "Yuvi Panda", "manual"),
148+
(root_doc, "BinderHub.tex", "BinderHub Documentation", "Yuvi Panda", "manual"),
149149
]
150150

151151

152152
# -- Options for manual page output ---------------------------------------
153153

154154
# One entry per manual page. List of tuples
155155
# (source start file, name, description, authors, manual section).
156-
man_pages = [(master_doc, "binderhub", "BinderHub Documentation", [author], 1)]
156+
man_pages = [(root_doc, "binderhub", "BinderHub Documentation", [author], 1)]
157157

158158

159159
# -- Options for Texinfo output -------------------------------------------
@@ -163,7 +163,7 @@
163163
# dir menu entry, description, category)
164164
texinfo_documents = [
165165
(
166-
master_doc,
166+
root_doc,
167167
"BinderHub",
168168
"BinderHub Documentation",
169169
author,

doc/customizing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ To do that add the following into your ``config.yaml``::
9898
args:
9999
- clone
100100
- --single-branch
101-
- --branch=master
101+
- --branch=main
102102
- --depth=1
103103
- --
104104
- <repo_url>

doc/developer/repoproviders.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Currently supported providers, their prefixes and specs are:
2424
| GitHub | ``gh`` | ``<user>/<repo>/<commit-sha-or-tag-or-branch>`` | `GitHub <https://github.com/>`_ is a website for hosting and sharing git repositories. |
2525
+------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
2626
| GitLab | ``gl`` | ``<url-escaped-namespace>/<unresolved_ref>`` | `GitLab <https://about.gitlab.com/>`_ offers hosted as well as self-hosted git repositories. |
27-
| | | (e.g. ``group%2Fproject%2Frepo/master``) | |
27+
| | | (e.g. ``group%2Fproject%2Frepo/main``) | |
2828
+------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
2929
| Gist | ``gist`` | ``<github-username>/<gist-id><commit-sha-or-tag>`` | `Gists <https://gist.github.com/>`_ are small collections of files stored on GitHub. They behave like lightweight repositories. |
3030
+------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@@ -47,7 +47,7 @@ a BinderHub deployment to fetch repositories from new locations
4747
on the web. Doing so involves defining your own RepoProvider sub-class
4848
and modifying a set of methods/attributes to interface with the online
4949
provider to which you are providing access. It also often involves
50-
`building a new repo2docker content provider <https://github.com/jupyter/repo2docker/tree/master/repo2docker/contentproviders>`_.
50+
`building a new repo2docker content provider <https://github.com/jupyter/repo2docker/tree/HEAD/repo2docker/contentproviders>`_.
5151

5252
In order to extend the supported repository providers,
5353
follow these instructions. We'll provide example links for each step to a
@@ -56,7 +56,7 @@ that implements the ``DataverseProvider`` class.
5656

5757
#. Review the `repoprovider module <https://github.com/jupyterhub/binderhub/blob/HEAD/binderhub/repoproviders.py>`_.
5858
This shows a number of example repository providers.
59-
#. Check whether repo2docker has a `ContentProvider class <https://github.com/jupyter/repo2docker/tree/master/repo2docker/contentproviders>`_
59+
#. Check whether repo2docker has a `ContentProvider class <https://github.com/jupyter/repo2docker/tree/HEAD/repo2docker/contentproviders>`_
6060
that will work with your repository provider. If not, then you'll need to create one first.
6161
#. Create a new class that sub-classes the ``RepoProvider`` class.
6262
Define your own methods for actions that are repository provider-specific.

doc/zero-to-binderhub/setup-prerequisites.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ render the templates into valid k8s resources. Each installation of a chart is
3131
called a *release*, and each version of the release is called a *revision*.
3232

3333
Several `methods to install Helm
34-
<https://github.com/helm/helm/blob/master/docs/install.md>`_ exist, the simplest
34+
<https://helm.sh/docs/intro/install/>`_ exist, the simplest
3535
way to install Helm is to run Helm's installer script in a terminal.
3636

3737
.. code:: bash
3838
39-
curl -sf https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
39+
curl -sf https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
4040
4141
Verifying the setup
4242
~~~~~~~~~~~~~~~~~~~

examples/appendix/binderhub_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
ENV BINDER_URL={binder_url}
44
ENV REPO_URL={repo_url}
55
RUN cd /tmp \
6-
&& wget -q https://github.com/jupyterhub/binderhub/archive/master.tar.gz -O binderhub.tar.gz \
6+
&& wget -q https://github.com/jupyterhub/binderhub/archive/main.tar.gz -O binderhub.tar.gz \
77
&& tar --wildcards -xzf binderhub.tar.gz --strip 2 */examples/appendix\
88
&& ./appendix/run-appendix \
99
&& rm -rf binderhub.tar.gz appendix

helm-chart/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ to build the docker images and rerender the helm chart.
5252
[kubernetes]: https://kubernetes.io
5353
[helm]: https://helm.sh/
5454
[helm repo]: https://github.com/kubernetes/helm
55-
[chart]: https://github.com/kubernetes/helm/blob/master/docs/charts.md
56-
[kubernetes introduction to charts]: https://github.com/kubernetes/helm/blob/master/docs/charts.md
55+
[chart]: https://helm.sh/docs/topics/charts/
56+
[kubernetes introduction to charts]: https://helm.sh/docs/topics/charts/
5757
[zero to jupyterhub with kubernetes]: https://zero-to-jupyterhub.readthedocs.io/en/latest/

0 commit comments

Comments
 (0)