Skip to content

Commit

Permalink
Merge pull request #1883 from rkratky/FR-6244_docs-update
Browse files Browse the repository at this point in the history
Misc. docs updates and fixes
  • Loading branch information
rkratky committed Jan 12, 2024
2 parents a16a69d + 562248a commit 753ce9f
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 10 deletions.
22 changes: 22 additions & 0 deletions doc/.sphinx/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -187,3 +187,25 @@ details summary {
color: var(--color-version-popup);
font-weight: bolder;
}

/* Code-block copybutton invisible by default
(overriding Furo config to achieve default copybutton setting). */
.highlight button.copybtn {
opacity: 0;
}

/* Mimicking the 'Give feedback' button for UX consistency */
.sidebar-search-container input[type=submit] {
color: #FFFFFF;
border: 2px solid #D6410D;
padding: var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal);
background: #D6410D;
font-weight: bold;
font-size: var(--font-size--small);
cursor: pointer;
}

.sidebar-search-container input[type=submit]:hover {
text-decoration: underline;
}

2 changes: 1 addition & 1 deletion doc/.sphinx/_static/github_issue_links.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
.github-issue-link {
font-size: var(--font-size--small);
font-weight: bold;
background-color: #DD4814;
background-color: #D6410D;
padding: 13px 23px;
text-decoration: none;
}
Expand Down
7 changes: 7 additions & 0 deletions doc/.sphinx/_templates/sidebar/search.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<form class="sidebar-search-container" method="get" action="{{ pathto('search') }}" role="search">
<input class="sidebar-search" placeholder="{{ _("Search") }}" name="q" aria-label="{{ _("Search" ) }}">
<input type="submit" value="Go">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div>
8 changes: 4 additions & 4 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
'sphinx_design',
'sphinx_tabs.tabs',
'sphinx_reredirects',
'youtube-links',
'related-links',
'custom-rst-roles',
'terminal-output',
'canonical.youtube-links',
'canonical.related-links',
'canonical.custom-rst-roles',
'canonical.terminal-output',
'sphinx_copybutton',
'sphinxext.opengraph',
'myst_parser',
Expand Down
4 changes: 1 addition & 3 deletions doc/howto/report-bugs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,4 @@ To create a Launchpad bug report based on the contents of a crash report, use th
To run ``apport-cli`` in the installer environment, switch to a shell. This way, ``apport`` can not open a browser to for you to complete the report. Instead, it provides a URL for completing the report, which you can do on another computer.

.. note::

Issues for the Subiquity autoinstaller are `tracked in Launchpad <https://bugs.launchpad.net/subiquity>`_.
.. note:: Issues for the Subiquity autoinstaller are `tracked in Launchpad <https://bugs.launchpad.net/subiquity>`_.
4 changes: 2 additions & 2 deletions doc/intro-to-autoinstall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ any interaction.


Differences from `debian-installer` preseeding
============================================
==============================================

*preseeds* are the way to automate an installer based on `debian-installer`
(also known as d-i).
Expand All @@ -43,7 +43,7 @@ There are 2 ways to provide the autoinstall configuration:
* Directly on the installation media

Autoinstall by way of `cloud-config`
----------------------------------
------------------------------------

The suggested way of providing autoinstall configuration to the Ubuntu installer is
via cloud-init. This allows the configuration to be applied to the installer
Expand Down

0 comments on commit 753ce9f

Please sign in to comment.