From 4bad05149402c0feaeb49f1a824e0b26a6c6ab2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Mon, 23 Oct 2023 16:28:43 +0200 Subject: [PATCH] Update and fix project navigation * Header titles & links * Footer links * Feedback button --- doc/.sphinx/_static/github_issue_links.js | 13 +------------ doc/.sphinx/_templates/footer.html | 2 +- doc/.sphinx/_templates/header.html | 2 +- doc/custom_conf.py | 10 +++++----- 4 files changed, 8 insertions(+), 19 deletions(-) diff --git a/doc/.sphinx/_static/github_issue_links.js b/doc/.sphinx/_static/github_issue_links.js index f0706038b..7f0bddbf1 100644 --- a/doc/.sphinx/_static/github_issue_links.js +++ b/doc/.sphinx/_static/github_issue_links.js @@ -11,18 +11,7 @@ window.onload = function() { link.classList.add("muted-link"); link.classList.add("github-issue-link"); link.text = "Give feedback"; - link.href = ( - github_url - + "/issues/new?" - + "title=docs%3A+TYPE+YOUR+QUESTION+HERE" - + "&body=*Please describe the question or issue you're facing with " - + `"${document.title}"` - + ".*" - + "%0A%0A%0A%0A%0A" - + "---" - + "%0A" - + `*Reported+from%3A+${location.href}*` - ); + link.href = ("https://bugs.launchpad.net/subiquity/+filebug"); link.target = "_blank"; const div = document.createElement("div"); diff --git a/doc/.sphinx/_templates/footer.html b/doc/.sphinx/_templates/footer.html index f13cb6314..d12080d25 100644 --- a/doc/.sphinx/_templates/footer.html +++ b/doc/.sphinx/_templates/footer.html @@ -84,7 +84,7 @@ {% if github_issues %}
- Open a GitHub issue for this page + Open a Launchpad issue for this documentation
{% endif %} diff --git a/doc/.sphinx/_templates/header.html b/doc/.sphinx/_templates/header.html index 1a128b6f8..04f052a1b 100644 --- a/doc/.sphinx/_templates/header.html +++ b/doc/.sphinx/_templates/header.html @@ -7,7 +7,7 @@
  • diff --git a/doc/custom_conf.py b/doc/custom_conf.py index 284a49e33..2ed3ea1f2 100644 --- a/doc/custom_conf.py +++ b/doc/custom_conf.py @@ -15,7 +15,7 @@ ############################################################ # Product name -project = 'Ubuntu Install Guide' +project = 'Ubuntu installation' author = 'Canonical Group Ltd' # Uncomment if your product uses release numbers @@ -41,7 +41,7 @@ # The URL of the documentation output ogp_site_url = 'https://canonical-subiquity.readthedocs-hosted.com/' # The documentation website name (usually the same as the product name) -ogp_site_name = project +ogp_site_name = 'Ubuntu Installation Guide' # An image or logo that is used in the preview ogp_image = 'https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg' @@ -53,7 +53,7 @@ html_context = { # Change to the link to your product website (without "https://") - 'product_page': 'documentation.ubuntu.com', + 'product_page': 'ubuntu.com/download', # Add your product tag to ".sphinx/_static" and change the path # here (start with "_static"), default is the circle of friends @@ -62,7 +62,7 @@ # Change to the discourse instance you want to be able to link to # using the :discourse: metadata at the top of a file # (use an empty value if you don't want to link) - 'discourse': 'https://discourse.ubuntu.com', + 'discourse': 'https://discourse.ubuntu.com/c/foundations/', # Change to the GitHub info for your project 'github_url': 'https://github.com/canonical/subiquity', @@ -76,7 +76,7 @@ # Change to an empty value if your GitHub repo doesn't have issues enabled. # This will disable the feedback button and the issue link in the footer. - 'github_issues': '', + 'github_issues': 'https://bugs.launchpad.net/subiquity', # Controls the existence of Previous / Next buttons at the bottom of pages # Valid options: none, prev, next, both