Skip to content

Commit

Permalink
Merge pull request #475 from phillxnet/473-Resolve-latest-linkcheck-i…
Browse files Browse the repository at this point in the history
…ssues

Resolve latest linkcheck issues #473
  • Loading branch information
phillxnet authored Jun 4, 2024
2 parents ff51501 + 7e9216f commit c6a32b9
Show file tree
Hide file tree
Showing 20 changed files with 72 additions and 268 deletions.
4 changes: 2 additions & 2 deletions contribute/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ This repository has 2 main git branches:
If all is well during field testing via our testing channel packages,
the exact same patch may be cherry-picked for inclusion in the stable release.

Begin by `Creating your own forking <https://github.com/rockstor/rockstor-core/fork>`_ via GitHub's Web-UI.
Begin by creating your own GitHub **fork** at `rockstor-core <https://github.com/rockstor/rockstor-core>`_ via GitHub's Web-UI.

.. warning::
You must **untick** *"Copy the master branch only"* if you intend to contribute to the testing channel.
Expand All @@ -69,7 +69,7 @@ The high level flow of an individual contribution is as follows.

1. Search for an existing issue or start a new issue using the `Issue Tracker <https://github.com/rockstor/rockstor-core/issues>`_.
2. Make and test code changes locally on a Rockstor install with the rpm package removed.
3. Submit your changes in a single `pull request <https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_.
3. Submit your changes in a single `pull request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_.
4. Use the issue tracker for discussions as necessary.
5. Close the issue when your pull request is merged.

Expand Down
2 changes: 1 addition & 1 deletion contribute/contribute_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Using Sphinx as a Docker container
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sphinx can also be used as a Docker container, without needing to install it on
your computer. As the base `docker-sphinx <https://github.com/sphinx-doc/docker>`_
your computer. As the base `docker-sphinx <https://github.com/sphinx-doc/sphinx-docker-images>`_
image doesn't contain the **sphinxext-rediraffe** extension needed to build
Rockstor's documentation, we need to use a custom Docker image. This can easily
be done using a `custom Dockerfile <https://github.com/rockstor/rockstor-doc/blob/master/docker/Dockerfile>`_.
Expand Down
45 changes: 13 additions & 32 deletions faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,46 +150,27 @@ The :ref:`testing_channel` or :ref:`stable_channel` repositories.

The following repositories are included and enabled in :ref:`installer_howto`:

* `OSS <https://en.opensuse.org/Package_repositories#OSS>`_ (open source software only)
* `OSS <https://en.opensuse.org/Package_repositories#OSS>`_ (open source software only) Aliased "Leap_**_*".

* `Update <https://en.opensuse.org/Package_repositories#Update>`_ (security and bugfix updates for OSS packages)

Aliased as per the installer profile: e.g. "Leap_15_3" & "Leap_15_3_Updates" respectively.

**Leap 15.2 profiles** have the following additional repositories:-

* `shells <https://build.opensuse.org/project/show/shells>`_
An OBS repo for shellinabox - used by our Web-UI shell function.
* `Update <https://en.opensuse.org/Package_repositories#Update>`_ (security and bugfix updates for OSS packages) Aliased "Leap_**_*_Updates".

* `home_rockstor_branches_Base_System <https://build.opensuse.org/project/subprojects/home:rockstor>`_
Rockstor's OBS repo for branding packages.

We are required to de/re-brand packages that have no
"...branding-upstream" equivalent". See: `Making_an_openSUSE_based_distribution
<https://en.opensuse.org/Archive:Making_an_openSUSE_based_distribution>`_


**Leap 15.3 profiles** and newer - shells is replaced with Rockstor's OBS
home_rockstor; there was no Leap 15.3 ARM64 shellinabox package available otherwise:-
We are required to de/re-brand packages that have no "...branding-upstream" equivalent".
See: `Making_an_openSUSE_based_distribution <https://en.opensuse.org/Archive:Making_an_openSUSE_based_distribution>`_

* `home_rockstor <https://build.opensuse.org/project/show/home:rockstor>`_
Multi-arch Shellinabox with no changes from upstream:

* `home_rockstor_branches_Base_System <https://build.opensuse.org/project/subprojects/home:rockstor>`_
As for Leap 15.2 Profiles.

The following are new in upstream openSUSE Leap 15.3: see
`Upstream release notes <https://doc.opensuse.org/release-notes/x86_64/openSUSE/Leap/15.3/#installation-new-update-repos>`_
They are included but no persisted by our installer build process.
However they are identical to those added by a regular openSUSE Leap 15.3 update.
And so are also auto included in the resulting install.

* `repo-backports-update <http://download.opensuse.org/update/leap/15.3/backports/>`_
Update repository of openSUSE Backports

* `repo-sle-update <http://download.opensuse.org/update/leap/15.3/sle/>`_
Update repository with updates from SUSE Linux Enterprise 15

* `repo-openh264 <http://codecs.opensuse.org/openh264/openSUSE_Leap>`_
To provide `Open H264 capabilities <https://news.opensuse.org/2023/01/24/opensuse-simplifies-codec-install>`_.

Debug-info counterparts "repo-backports-debug-update" & "repo-sle-debug-update" are also added but are not enabled.
These are not used during the installer build.

Expand Down Expand Up @@ -295,10 +276,10 @@ confines users from using BTRFS more freely, thus reducing the chances of
hitting deep intricate bugs. The fact that BTRFS bugs being reported lately are
only triggered by very special scenarios is an encouraging sign.

However a proviso here is that The BTRFS community consensus is that **raid5
and raid6** levels of btrfs support are not yet fully stable and so are ***not
recommended for production use***. Please see the `btrfs wiki
<https://btrfs.wiki.kernel.org/index.php/Main_Page>`_ for up to date
However a proviso here is that the BTRFS community consensus has **btrfs-raid5
and btrfs-raid6** parity levels of as not yet fully stable; and so are ***not
recommended for production use***. Please see the `btrfs docs
<https://btrfs.readthedocs.io/en/latest/Introduction.html>`_ for up to date
information on all btrfs matters.


Expand All @@ -316,8 +297,8 @@ How can I stay in touch with the latest Rockstor news?
------------------------------------------------------

We recommend you join our `community forum <https://forum.rockstor.com>`_,
follow the `rockstor-core project <https://github.com/rockstor/rockstor-core>`_
on github, and follow us on `twitter <https://twitter.com/rockstorinc>`_.
follow the `rockstor-core project <https://github.com/rockstor/rockstor-core>`_ on github,
and follow us on Masterdon `@TheRockstorProject <https://mastodon.world/@TheRockstorProject>`_.


How can I contribute to Rockstor?
Expand Down
2 changes: 1 addition & 1 deletion howtos/gnome_disks_usb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Rockstor USB install disk using Gnome Disks

Many popular linux desktop distributions including
`Ubuntu <https://ubuntu.com/desktop>`_,
`Fedora <https://getfedora.org/>`_, and many others, include the
`Fedora <https://fedoraproject.org/>`_, and many others, include the
gnome-disks program by default and as such have a built-in graphical way to
create a Rockstor USB install disk from the downloadable iso file. What follows
is a step by step guide of this process. Please see the
Expand Down
2 changes: 1 addition & 1 deletion howtos/rufus_howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Rockstor USB install disk using Rufus
`Rufus 3.4 <https://rufus.ie/>`_ is an open source multilingual general
purpose graphical utility for Windows 7 and newer systems to help in the
creation of bootable USB flash drives. It is licensed under
`GNU GPLv3 or later <https://www.gnu.org/licenses/gpl.html>`_. Using it's
`GNU GPLv3 or later <https://www.gnu.org/licenses/gpl-3.0.html>`_. Using it's
default settings it will **NOT** create a working Rockstor USB install disk.
However, using the following configuration options, it can successfully prepare
a working USB flash drive to be used for Rockstor install. Please see the
Expand Down
2 changes: 1 addition & 1 deletion howtos/soho.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ further.
On Windows or Fedora operating systems, the Fedora Media Writer program can be
used to prepare your USB flash drive with the Rockstor ISO file. If you are
using the Windows operating system then Fedora Media Writer can be downloaded
from `GetFedora.org <https://getfedora.org/fmw/FedoraMediaWriter-win32-latest.exe>`_
from `GetFedora.org <https://fedoraproject.org/fmw/FedoraMediaWriter-win32-latest.exe>`_
and install it. On Fedora, run the following command::

# sudo dnf install mediawriter
Expand Down
2 changes: 1 addition & 1 deletion installation/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ See :ref:`minsysreqs` for the basic requirements.
Rockstor developers and the user community share hardware specs known to work well with Rockstor.
Visiting our `Forum <https://forum.rockstor.com>`_
for user stories, example builds, and to request advice on hardware choice or current recommendations.
There is also a `Hardware <https://forum.rockstor.com/c/hardware/l/latest>`_ tag available.
There is also a `Hardware <https://forum.rockstor.com/c/hardware/18/l/latest>`_ tag available.

.. _updating_rockstor:

Expand Down
5 changes: 3 additions & 2 deletions installation/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ Data drives advisory
.. warning::

Rockstor v4.1.0-0 and older have a 1 GiB 'ignore' threshold.
See `if your device is small <https://btrfs.wiki.kernel.org/index.php/FAQ#if_your_device_is_small>`_
Newer stable versions have a 5 GiB 'ignore' threshold.
See `btrfs docs --mixed <https://btrfs.readthedocs.io/en/latest/mkfs.btrfs.html#options>`_
in the btrfs wiki regarding our 16 GiB recommended minimum.
Note: Rockstor does not use the "--mixed" format option; irrespective of drive size.

Expand Down Expand Up @@ -111,7 +112,7 @@ GUI options

On a Linux Unity or Gnome Desktop see our :ref:`gnome_disks_howto`.

On a Windows Desktop consider using a fairly intuitive solution like `balenaEtcher <https://www.balena.io/etcher/>`_.
On a Windows Desktop consider using a fairly intuitive solution like `balenaEtcher <https://etcher.balena.io>`_.

**Please note** the following USB image writing programs have been found to produce **NON working USB install disks** when used with the Rockstor ISO and their default settings.

Expand Down
15 changes: 3 additions & 12 deletions interface/docker-based-rock-ons/minio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ requirement.
What is MinIO
-----------------

`MinIO <https://min.io>`_ is an open-source, high-performance, distributed
`MinIO <https://min.io/product/overview>`_ is an open-source, high-performance, distributed
S3-compatible object storage system. MinIO can scale from a single server with
a single object store all the way to a fault-tolerant commercial-grade
distributed infrastrucure. This MinIO Rock-on targets the low end, creating a
distributed infrastructure. This MinIO Rock-on targets the low end, creating a
single MinIO server using a single Rockstor share as its object store. This
configuration should be perfect for catching backups on a home server, for
example.
Expand All @@ -31,16 +31,7 @@ certificate management in addition to the MinIO Rock-on installation. This
would violate the '"all-in-one" user experience' guideline in
:ref:`contributerockons`.


.. _minio_doc:

MinIO Documentation
-------------------

If you want a deep dive into the full range of MinIO capabilities, the MinIO
project maintains extensive, well-written `documentation <https://docs.min.io/>`_
covering many different deployment models. You don't need to worry about all
that to use this Rock-on, though. Simply point your MinIO-enabled client at
Simply point your MinIO-enabled client at
the URL for your server (``http://domain-name:port``) and use the Access Key
(username) and Secret Key (password) that you specified during installation.

Expand Down
5 changes: 2 additions & 3 deletions interface/docker-based-rock-ons/netdata_official.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,14 @@ requirements.
What is Netdata
---------------

`Netdata <https://www.netdata.cloud/agent>`_ Agent is a free an open-source
`Netdata <https://www.netdata.cloud/open-source/>`_ Agent is a free an open-source
tool to monitor and analyze the performance of your system in real time. It
gathers a wealth of metrics from the operating system, hardware, as well as
applications (including rock-ons), and display them in a modern and descriptive
interface. Netdata also allows you to set different alerts to get notified when
a specific metric reaches a designated threshold.
For further details and up-to-date description of Netdata, please visit the
`project's documentation <https://learn.netdata
.cloud/docs/overview/what-is-netdata>`_.
`project's documentation <https://learn.netdata.cloud/docs/deployment-guides>`_.

.. _netdata_doc:

Expand Down
166 changes: 0 additions & 166 deletions interface/docker-based-rock-ons/owncloud.rst

This file was deleted.

Loading

0 comments on commit c6a32b9

Please sign in to comment.