Skip to content

Commit

Permalink
fix(docs): Some typos errors
Browse files Browse the repository at this point in the history
  • Loading branch information
fv3rdugo committed Sep 17, 2024
1 parent 397ff2a commit f1e73d5
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 17 deletions.
13 changes: 6 additions & 7 deletions docs/docs/INSTALL_Rocky9.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Install Ravada on Rocky Linux 9 or RHEL9
========================
========================================

Add Pre-Requisite Software
------------
--------------------------

.. prompt:: bash $

Expand Down Expand Up @@ -38,7 +38,7 @@ Grant all permissions on this database to the *rvd_user*:
sudo mysql -u root -p ravada -e "grant all on ravada.* to rvd_user@'localhost' identified by 'Pword12345*'"

Add Another Pre-Requisite Software
------------
----------------------------------

.. prompt:: bash $

Expand Down Expand Up @@ -113,15 +113,15 @@ The faster the disks, the better. Ravada uses incremental files for the
disks images, so clones won't require many space.

Make sure you are in root folder
-------------
--------------------------------

.. prompt:: bash $

cd /root


Download Ravada from Git Repo
--------------
-----------------------------

.. prompt:: bash $

Expand Down Expand Up @@ -173,7 +173,6 @@ Now, it's time to install rvd_back service
.. prompt:: bash $

perl /root/ravada/script/rvd_back
.

Once the rvd_back is installed, we need to add the admin for the web interface:
Add a new user for the ravada web. Use rvd\_back to create it. It will perform some initialization duties in the database the very first time this script is executed.
Expand Down Expand Up @@ -245,4 +244,4 @@ Go ahead and restart rvd_back, rvd_front, and libvirtd to ensure everything is w


Once everything goes as expected, you should be able to get to ravada web user-interface at:
http://your.ip:8081/ or http://127.0.0.1:8081 if you run it in your own workstation.
http://your.ip:8081/ or http://127.0.0.1:8081 if you run it in your own workstation.
4 changes: 2 additions & 2 deletions docs/docs/auth_openid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Install modules
sudo a2enmod auth_openidc

Configure module
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~

/etc/apache2/mods-available/auth_openidc.conf

Expand Down Expand Up @@ -77,7 +77,7 @@ Ravada needs to know OpenID login is enabled and the logout page.
Go to *Admin tools* and choose *Settings*. There enable *OpenID*
and define a *logout URL*.

.. image:: images/enable_openid.jpg
.. image:: images/enable_openid.png

Configure Custom Login page
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/update_safe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This is the ugprade procedure when you want to keep everything
just in case you wanted to roll back to the previous version.

Step 1: Shutdown the services
---------------------
-----------------------------

.. prompt:: bash

Expand All @@ -14,10 +14,10 @@ Step 1: Shutdown the services


Step 2: Keep the package and data
--------------------------------------
---------------------------------

Step 2.1: Keep the package file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you installed the package it must be in the server somewhere.
It is a *deb* file called ravada_x.y.z_system-version_all.deb.
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/users_upload.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We consider plain users as usernames stored in the SQL database.
Create a file with names and passwords separated by colon (:)
and upload it.

.. image:: image/upload_users_plain.png
.. image:: images/upload_users_plain.png

Delegated login
~~~~~~~~~~~~~~~
Expand All @@ -36,7 +36,7 @@ From now on only previously authorized users can log in.

Then upload a file with a list of allowed usernames.

.. image:: image/upload_users_openid.png
.. image:: images/upload_users_openid.png

Groups
======
Expand All @@ -50,7 +50,7 @@ Uploading with web browser
Just create a text file with a list of users, one at each line
and upload from the "Group Administration" page.

.. image:: image/manage_group_members.png
.. image:: images/manage_group_members.png

CLI
~~~
Expand All @@ -76,7 +76,7 @@ The group name can be supplied if necessary:
sudo rvd_back --upload-group-members=members.txt --group=students

Add members to many groups
------------------------
--------------------------

If you want to create a large amount of groups, store the files in
a directory and pass it to the CLI. All the groups will be created
Expand Down
15 changes: 14 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Do you feel like giving us a hand? Here you have all the information you need as
docs/INSTALL
docs/INSTALL_Ubuntu
docs/INSTALL_Debian
docs/Debian_install
docs/INSTALL_Fedora
docs/INSTALL_Rocky9
docs/INSTALL_ubuntu_xenial.rst
Expand All @@ -75,6 +76,7 @@ Do you feel like giving us a hand? Here you have all the information you need as
docs/ldap_local
docs/new_kvm_template
docs/new_iso_image
docs/Localized_ISO_download
docs/OpenGnsys_import_image.rst
docs/OpenGnsys_iPXE_support.rst
docs/operation
Expand All @@ -86,6 +88,7 @@ Do you feel like giving us a hand? Here you have all the information you need as
docs/windows_clients
docs/mac_clients
docs/macos_spice_client
docs/RDP_connection
docs/change_windows_driver_to_virtio
docs/Backup
docs/migrate_manual
Expand All @@ -98,9 +101,17 @@ Do you feel like giving us a hand? Here you have all the information you need as
docs/CLI
docs/Automatic_daily_operations
docs/sso_login
docs/sso_openid
docs/auth_openid
docs/apparmor
docs/status
docs/compact
docs/install_tpm
docs/mount_virtual_volume
docs/replace_server
docs/report_rrdgraph
docs/users_upload
docs/volume_difference
docs/ROADMAP

.. _feature-docs:

Expand Down Expand Up @@ -167,6 +178,8 @@ Do you feel like giving us a hand? Here you have all the information you need as
devel-docs/development_tools
devel-docs/commit-rules
devel-docs/database_changes
devel-docs/create_grants
devel-docs/profiling
devel-docs/editor-rules
devel-docs/local_iso_server
devel-docs/run
Expand Down

0 comments on commit f1e73d5

Please sign in to comment.