diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dfcf9aee..e11a3c27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing Welcome! As a [Jupyter](https://jupyter.org) project, we follow the [Jupyter contributor guide](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html) -and [Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md). +and [Code of Conduct](https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md). To set up a development environment for this repository: diff --git a/RELEASE.md b/RELEASE.md index 1d4a7454..a3fec1f4 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -13,13 +13,13 @@ For you to follow along according to these instructions, you need: ## Steps to make a release -1. Checkout master and make sure it is up to date. +1. Checkout main and make sure it is up to date. ```shell ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo - git checkout master - git fetch $ORIGIN master - git reset --hard $ORIGIN/master + git checkout main + git fetch $ORIGIN main + git reset --hard $ORIGIN/main # WARNING! This next command deletes any untracked files in the repo git clean -xfd ``` @@ -47,15 +47,15 @@ For you to follow along according to these instructions, you need: git commit -m "back to dev" ``` -1. Push your two commits to master. +1. Push your two commits to main. ```shell # first push commits without a tags to ensure the # commits comes through, because a tag can otherwise # be pushed all alone without company of rejected # commits, and we want have our tagged release coupled - # with a specific commit in master - git push $ORIGIN master + # with a specific commit in main + git push $ORIGIN main ``` 1. Create a git tag for the pushed release commit and push it. diff --git a/docs/source/conf.py b/docs/source/conf.py index f0aa8bdf..3a98274f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,7 +20,7 @@ copyright = 'Jupyter Contributors' author = 'Jupyter Contributors' -master_doc = 'index' +root_doc = master_doc = 'index' import oauthenticator diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index e6c0ad4b..a72e6238 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -156,7 +156,7 @@ This sample code is provided for you in ``examples > azuread > sample_jupyter_co - See ``run.sh`` for an `example <./examples/azuread/>`__ -- `Source Code `__ +- `Source Code `__ GitHub Setup @@ -415,7 +415,7 @@ Globus Scopes and Transfer ~~~~~~~~~~~~~~~~~~~~~~~~~~ The following shows how to get tokens into user Notebooks. `You can see how users -use tokens here `__. +use tokens here `__. If you want a demonstration, you can visit `The Jupyter Globus Demo Server `__. The default server configuration will automatically setup user environments @@ -584,9 +584,9 @@ Examples -------- For an example docker image using OAuthenticator, see the -`examples `__ directory. +`examples `__ directory. `Another -example `__ +example `__ is using GitHub OAuth to spawn each user’s server in a separate docker container. diff --git a/docs/source/index.rst b/docs/source/index.rst index 1182d225..f8e3fc1a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,8 +1,3 @@ -.. OAuthenticator documentation master file, created by - sphinx-quickstart on Tue Dec 3 10:38:44 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - ============== OAuthenticator ============== diff --git a/oauthenticator/gitlab.py b/oauthenticator/gitlab.py index 626f3ca4..5d0fbd09 100644 --- a/oauthenticator/gitlab.py +++ b/oauthenticator/gitlab.py @@ -118,7 +118,7 @@ async def authenticate(self, handler, data=None): # Exchange the OAuth code for a GitLab Access Token # - # See: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/oauth2.md + # See: https://github.com/gitlabhq/gitlabhq/blob/HEAD/doc/api/oauth2.md # GitLab specifies a POST request yet requires URL parameters params = dict( diff --git a/oauthenticator/globus.py b/oauthenticator/globus.py index 7ae36e4f..e3e78116 100644 --- a/oauthenticator/globus.py +++ b/oauthenticator/globus.py @@ -31,7 +31,7 @@ async def get(self): # Ensure self.handle_logout() is called before self.default_handle_logout() # If default_handle_logout() is called first, the user session is popped and # it's not longer possible to call get_auth_state() to revoke tokens. - # See https://github.com/jupyterhub/jupyterhub/blob/master/jupyterhub/handlers/login.py # noqa + # See https://github.com/jupyterhub/jupyterhub/blob/HEAD/jupyterhub/handlers/login.py # noqa await self.handle_logout() await self.default_handle_logout() if self.authenticator.logout_redirect_url: