Merge pull request #1850 from rkratky/FR-5543_feedback-button

Update and fix project navigation in docs
This commit is contained in:
Dan Bungert 2023-10-23 12:02:49 -06:00 committed by GitHub
commit 3cd76f11e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 19 deletions

View File

@ -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");

View File

@ -84,7 +84,7 @@
{% if github_issues %}
<div class="issue-github">
<a class="muted-link" href="{{ github_url }}/issues/new?title=doc%3A+ADD+A+TITLE&body=DESCRIBE+THE+ISSUE%0A%0A---%0ADocument: {{ pagename }}{{ page_source_suffix }}">Open a GitHub issue for this page</a>
<a class="muted-link" href="https://bugs.launchpad.net/subiquity/+filebug">Open a Launchpad issue for this documentation</a>
</div>
{% endif %}

View File

@ -7,7 +7,7 @@
<li>
<a class="p-logo" href="https://{{ product_page }}" aria-current="page">
<img src="{{ pathto(product_tag,1) }}" alt="Logo" class="p-logo-image">
<div class="p-logo-text p-heading--4">{{ project }}
<div class="p-logo-text p-heading--4">{{ project.title() }}
</div>
</a>
</li>

View File

@ -15,7 +15,7 @@ import datetime
############################################################
# Product name
project = 'Ubuntu Install Guide'
project = 'Ubuntu installation'
author = 'Canonical Group Ltd'
# Uncomment if your product uses release numbers
@ -41,7 +41,7 @@ copyright = '%s, %s' % (datetime.date.today().year, author)
# 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_favicon = '.sphinx/_static/favicon.png'
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 @@ html_context = {
# 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 @@ html_context = {
# 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