starlingx/docs
Code Issues Proposed changes

Change links provided in doc for users

Browse Source 
In bullet point 4 inside the Host Setup topic, the link provided to
download the ISO gives the user too many options and unclear
instructions on wher exactly to find the ISO file. We propose that
the first link is always to the latest release and then additional
versions can be found on a second link. Other references to the
mirror are updated as well.

Additionally, on the Introduction page (https://docs.starlingx.io/),
the provided link is for release 8. We also changed it to point to
the latest release. The main page still shows the current version,
however now the change is pretty straighforwar for when new releases
come.

Closes-Bug: 2016032

Change-Id: I94201ef4f436b137f2601b033cb344d726384b55
Signed-off-by: Bruno Muniz <bruno.muniz@encora.com>
This commit is contained in:
Lucas Terranova Barberio 2023-04-12 15:14:41 -03:00 committed by Bruno Muniz
parent 8a0ca8ad84
commit a196102577
3 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/deploy_install_guides/bootable_usb.rst
View File

@ -25,9 +25,9 @@ Create a bootable USB drive on Linux\*
sudo -s sudo -s
#. Get the StarlingX ISO from the #. Get the latest StarlingX ISO from the
`CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/>`_. `CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/debian/monolithic/outputs/iso/>`_.
Alternately, you can use an ISO from a private StarlingX build. Alternately, you can get an older release ISO from `here <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/>`_.
#. Navigate to the directory with the `StarlingX ISO <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/centos/flock/outputs/iso/>`_. #. Navigate to the directory with the `StarlingX ISO <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/centos/flock/outputs/iso/>`_.
@ -68,8 +68,9 @@ Create a bootable USB drive on macOS\*
#. Launch the Terminal app. #. Launch the Terminal app.
#. Get the StarlingX ISO from the #. Get the latest StarlingX ISO from the
`CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/>`_. Alternately, you can use an ISO from a private StarlingX build. `CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/debian/monolithic/outputs/iso/>`_.
Alternately, you can get an older release ISO from `here <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/>`_.
#. Navigate to the directory with the ISO. #. Navigate to the directory with the ISO.
@ -111,8 +112,9 @@ Create a bootable USB drive on macOS\*
Create a bootable USB drive on Windows\* Create a bootable USB drive on Windows\*
---------------------------------------- ----------------------------------------
#. Get the StarlingX ISO from the #. Get the latest StarlingX ISO from the
`CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/>`_. Alternately, you can use an ISO from a private StarlingX build. `CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/debian/monolithic/outputs/iso/>`_.
Alternately, you can get an older release ISO from `here <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/>`_.
#. Download the `Rufus`_ utility to burn the image onto a USB drive. #. Download the `Rufus`_ utility to burn the image onto a USB drive.
**Only use the latest version of Rufus**. **Only use the latest version of Rufus**.

6
doc/source/deploy_install_guides/release/virtual/physical_host_req.txt
View File

@ -67,6 +67,6 @@ Set up the host with the following steps:
apparmor-profile modules. apparmor-profile modules.
#. Get the StarlingX ISO from the #. Get the latest StarlingX ISO from the
`CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/>`_. `CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/debian/monolithic/outputs/iso/>`_.
Alternately, you can use an ISO from a private StarlingX build. Alternately, you can get an older release ISO from `here <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/>`_.

4
doc/source/index.rst
View File

@ -9,9 +9,9 @@ everything needed to deploy an edge cloud on one, two, or up to 100 servers.
* See the :ref:`release-notes`. * See the :ref:`release-notes`.
* Download the pre-built ISO (CentOS and Debian) and Docker images for * Download the pre-built ISO (CentOS and Debian) and Docker images for
StarlingX release 8.0 that are located at the ``CENGN StarlingX mirror`` repos: StarlingX latest release that are located at the ``CENGN StarlingX mirror`` repos:
- https://mirror.starlingx.cengn.ca/mirror/starlingx/release/8.0.0/debian/monolithic/outputs/iso/ - https://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/debian/monolithic/outputs/iso/
For more information about the StarlingX project, refer to the For more information about the StarlingX project, refer to the
`StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_. `StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_.