Skip to content

Commit

Permalink
Remove fix tutorial (#3314)
Browse files Browse the repository at this point in the history
* Remove fix tutorial
* Add package update step for the benefit of the CVE page
  • Loading branch information
s-makin authored Sep 20, 2024
1 parent f93db8c commit 9126431
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 80 deletions.
13 changes: 8 additions & 5 deletions docs/explanations/fix_scenarios.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,17 @@ Common scenarios when using ``pro fix`` to solve a CVE/USN
.. Into "what is pro fix" shared with the related tutorial
.. include:: ../includes/pro-fix-intro.txt

In this article we will introduce the ``pro fix`` command, and then go into more details about the different scenarios you may encounter when using ``pro fix`` to resolve CVEs/USNs.
In this article we will introduce the ``pro fix`` command, and then go into
more details about the different scenarios you may encounter when using
``pro fix`` to resolve CVEs/USNs.

.. note::

If instead you look for a simpler guided tutorial to get started with
``pro fix`` please start at
:ref:`Use pro fix to solve a CVE/USN <pro-fix-tutorial>`.
If you want a simpler guide to get started with ``pro fix``, start with
:ref:`our security features tutorial <security-tutorial>`.
You can use the same VM-based environment created in that tutorial
to recreate the output shown below yourself. If you have already completed the tutorial, you may want to :ref:`skip this section <CVE-no-fix>`.
to recreate the output shown below yourself. If you have already completed
the tutorial, you may want to :ref:`skip this section <CVE-no-fix>`.


Use ``pro fix``
Expand Down Expand Up @@ -50,6 +52,7 @@ Every ``pro fix`` output has a similar output structure. It:

.. # The basic case is shared between Howto and Tutorial
.. include:: ../includes/pro-fix-simple-case.txt

.. _CVE-no-fix:

CVE/USN without a released fix
Expand Down
13 changes: 9 additions & 4 deletions docs/howtoguides/fix_how_to_resolve_given_cve.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,17 @@ In this guide, we will introduce the ``pro fix`` command and show how you can us

.. note::

If you are looking for a simpler guided tutorial to get started with
``pro fix``, please refer to the tutorial on
:ref:`Using pro fix to solve a CVE/USN <pro-fix-tutorial>`.
If you want a simpler guide to get started with ``pro fix``, start with
:ref:`our security features tutorial <security-tutorial>`.
You can use the same VM-based environment created in that tutorial
to recreate the output shown below yourself. If you have already completed the tutorial, you may want to :ref:`skip this section <CVE-no-fix>`.
to recreate the output shown below yourself.

Before you begin, you will need to update the Pro Client to the most recent
version:

.. code-block:: bash
$ sudo apt update && sudo apt install ubuntu-pro-client
Use ``pro fix``
===============
Expand Down
9 changes: 4 additions & 5 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ learning about ``pro``, how it works, and what it's capable of.

-----

Core tutorial
=============
Getting started
===============

This tutorial will help you get started with ``pro``. It introduces the main
commands available and helps to orient you with the basics of ``pro``.
Expand All @@ -24,7 +24,8 @@ works.
.. toctree::
:maxdepth: 1

tutorials/basic_commands.rst
Introduction to the Pro Client commands <tutorials/basic_commands.rst>
Explore your system's security with Pro <tutorials/security-with-pro.rst>

Further tutorials
=================
Expand All @@ -37,7 +38,5 @@ start. They are not sequential, so you can approach them in any order you like!
.. toctree::
:maxdepth: 1

tutorials/security-with-pro.rst
tutorials/fix_intro.rst
tutorials/create_a_fips_docker_image.rst
tutorials/host_apt_news.rst
66 changes: 0 additions & 66 deletions docs/tutorials/fix_intro.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/tutorials/security-with-pro.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.. _security-tutorial:

Exploring your system's security with Pro
*****************************************
Expand Down

0 comments on commit 9126431

Please sign in to comment.