Skip to content

Change button from "View Source" to "Edit on GitHub" #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
denis-yuen merged 3 commits into from
Jul 15, 2026
Merged

Change button from "View Source" to "Edit on GitHub" #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a8b182
do we need the second part?
denis-yuen Jul 9, 2026
33e9c45
curious if a new user agent helps
denis-yuen Jul 9, 2026
fa7ce2a
other link certificate had expired (ironic)
denis-yuen Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
# needs_sphinx = '1.0'

# https://github.com/sphinx-doc/sphinx/issues/7369 403 blocks by support.orcid.org
user_agent = 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.45 Safari/537.36'
user_agent = 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/149.0.0.0 Safari/537.36'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down Expand Up @@ -173,7 +173,13 @@
# Set canonical URL from the Read the Docs Domain
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

html_context = {}
html_context = {
"display_github": True, # Integrate GitHub
"github_user": "dockstore", # Username
"github_repo": "dockstore-documentation", # Repo name
"github_version": "develop", # Version
"conf_py_path": "/docs/", # Path in the checkout to the docs root
}

html_context["READTHEDOCS"] = False

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/getting-started-with-docker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Quay.io does not maintain a list of official images like Docker Hub, but you can

Looking for an oft-maintained image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Official images are generally well-maintained. By this we mean that they get frequent updates. Most Docker registries will show you the last time an image was updated, and will show a history going back several updates. This is important not only because it means you can get the latest features of new versions of software, but it also usually indicates that someone is paying attention to the security side of things too. No one wants to use a container only to discover that it still contains `the infamous log4j vulnerability <https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046>`__, after all.
Official images are generally well-maintained. By this we mean that they get frequent updates. Most Docker registries will show you the last time an image was updated, and will show a history going back several updates. This is important not only because it means you can get the latest features of new versions of software, but it also usually indicates that someone is paying attention to the security side of things too. No one wants to use a container only to discover that it still contains `the infamous log4j vulnerability <https://arstechnica.com/information-technology/2021/12/hackers-launch-over-840000-attacks-through-log4j-flaw/>`__, after all.

Security considerations
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down