WIP; initial changes to create PR

Author: ralf401

admin/console-rails-shell.include.rst

@@ -1,7 +1,11 @@
+Package installation:
+
 .. code-block:: sh
 
-   # package installation
-   $ zammad run rails c
+   zammad run rails c
+
+Source installation:
+
+.. code-block::
 
-   # source installation
-   $ rails c
+   rails c

admin/console.rst

@@ -37,19 +37,19 @@ a shell (e.g. for automation).
 
       .. code-block:: sh
 
-         $ docker compose run --rm zammad-railsserver bundle exec rails r '{COMMAND}'
+         docker compose run --rm zammad-railsserver bundle exec rails r '{COMMAND}'
 
    .. tab:: Package Installation
 
       .. code-block:: sh
 
-         $ zammad run rails r '{COMMAND}'
+         zammad run rails r '{COMMAND}'
 
    .. tab:: Source/Development Installation
 
       .. code-block:: sh
 
-         $ rails r '{COMMAND}'
+         rails r '{COMMAND}'
 
 .. _rails_shell:
 
@@ -65,7 +65,7 @@ It allows you to run several commands inside it.
 
       .. code-block:: sh
 
-         $ docker compose run --rm zammad-railsserver bundle exec rails c
+         docker compose run --rm zammad-railsserver bundle exec rails c
 
       .. tip:: If you use Portainer to manage your Docker containers,
          you can even use a
@@ -75,13 +75,13 @@ It allows you to run several commands inside it.
 
       .. code-block:: sh
 
-         $ $ zammad run rails c
+         zammad run rails c
 
    .. tab:: Source/Development Installation
 
       .. code-block:: sh
 
-         $ rails c
+         rails c
 
 .. hint:: **Starting Rails Console in Safe Mode**
 
@@ -98,7 +98,7 @@ It allows you to run several commands inside it.
 
       .. code-tab:: console Package Installation
 
-         $ ZAMMAD_SAFE_MODE=1 zammad run rails c
+         ZAMMAD_SAFE_MODE=1 zammad run rails c
          Zammad is running in safe mode. Any third-party services like Redis are ignored.
 
          There was an error trying to connect to Redis via redis://localhost:6379.
@@ -109,7 +109,7 @@ It allows you to run several commands inside it.
 
       .. code-tab:: console Source Installation
 
-         $ ZAMMAD_SAFE_MODE=1 rails c
+         ZAMMAD_SAFE_MODE=1 rails c
          Zammad is running in safe mode. Any third-party services like Redis are ignored.
 
          There was an error trying to connect to Redis via redis://localhost:6379.

admin/console/dangerzone-for-experts.rst

@@ -12,37 +12,41 @@ Deleting Records
 Removing Tickets (And Their Articles)
 -------------------------------------
 
+Delete a ticket (specified by database ID):
+
 .. code-block:: ruby
 
-   # Delete a ticket (specified by database ID)
-   >> Ticket.find(4).destroy
+   Ticket.find(4).destroy
 
-   # Delete all tickets
-   >> Ticket.destroy_all
+Delete all tickets:
 
-   # Keep some tickets (specified by database ID); delete the rest
-   >> tickets_to_keep = [1, 2, 3]
-   >> Ticket.where.not(id: tickets_to_keep).destroy_all
+.. code-block:: ruby
 
-Removing Users
---------------
+   Ticket.destroy_all
 
-.. warning::
+Keep some tickets (specified by database ID); delete the rest:
+
+.. code-block:: ruby
+
+   tickets_to_keep = [1, 2, 3]
+
+.. code-block:: ruby
 
-   Customers **may not** be deleted while they have tickets remaining in the
-   system.
+   Ticket.where.not(id: tickets_to_keep).destroy_all
 
-   As such, the examples below will delete not only the specified customers,
-   but **all tickets associated with them**, as well. Below commands remove
-   upon executing without any further warnings.
+Removing Users
+--------------
 
 .. hint::
 
-   If you're not sure what to do and need to learn more about what Zammad does
-   upon removing users, please consider using Zammad's UI options in stead.
+   Console based deletion is not recommended. Instead, use Zammad's
+   :admin-docs:`data privacy </system/data-privacy.html>` feature.
 
-   Our documentation for the :admin-docs:`data privacy </system/data-privacy.html>`
-   function will help you a lot!
+.. warning::
+
+   Customers **can't be** deleted while they have tickets remaining in the
+   system. Because of that, the examples below delete **all tickets associated
+   with them**, as well. The commands don't require a confirmation, be careful.
 
 Removing users is possible in 2 ways: A single user and in bulk.
 
@@ -52,71 +56,87 @@ Removing users is possible in 2 ways: A single user and in bulk.
 
       .. code-block:: ruby
 
-         >> User.find_by(email: '<email address>').destroy
+         User.find_by(email: '<email address>').destroy
 
    .. tab:: Remove several users
 
       .. code-block:: ruby
 
-         >> User.where(
-               email: ['<email address 1>', '<email address 2>']
-            ).destroy_all
+         User.where(
+            email: ['<email address 1>', '<email address 2>']
+         ).destroy_all
 
 Removing Organizations
 ----------------------
 
 .. note:: Removing an organization does **not** delete associated customers.
 
 Step 1: Select organizations
+   By "active" status:
+
    .. code-block:: ruby
 
-      # by "active" status
-      >> organizations = Organization.where(active: false)
+      organizations = Organization.where(active: false)
+
+   By name:
+
+   .. code-block:: ruby
+
+      organizations = Organization.where(name: 'Acme')
+
+   By partial match on notes content:
 
-      # by name
-      >> organizations = Organization.where(name: 'Acme')
+   .. code-block:: ruby
 
-      # by partial match on notes
-      >> organizations = Organization.where('note LIKE ?', '%foo%')
+      organizations = Organization.where('note LIKE ?', '%foo%')
 
 Step 2: Preview affected organizations
    .. code-block:: ruby
 
-      >> puts organizations.map { |org| "ORGANIZATION #{org.name}" }.join("\n")
+      puts organizations.map { |org| "ORGANIZATION #{org.name}" }.join("\n")
 
 Step 3: Proceed with deletion
    .. code-block:: ruby
 
-      >> organizations.each do |org|
-           puts %{Preparing deletion of organization "#{org.name}"...}
+      organizations.each do |org|
+        puts %{Preparing deletion of organization "#{org.name}"...}
 
-           org.members.each do |member|
-              puts "  Removing #{member.fullname} from organization..."
-              member.update!(organization_id: nil)
-           end
+        org.members.each do |member|
+           puts "  Removing #{member.fullname} from organization..."
+           member.update!(organization_id: nil)
+        end
 
-           puts "  Deleting #{org.name}..."
-           org.destroy
-         end
+        puts "  Deleting #{org.name}..."
+        org.destroy
+      end
 
 Removing System Records
 -----------------------
 
+Remove all online notifications:
+
+.. code-block:: ruby
+
+   OnlineNotification.destroy_all
+
+Remove all entries from the Activity Stream (dashboard):
+
+.. code-block:: ruby
+
+   ActivityStream.destroy_all
+
+Remove entries for all recently viewed objects (tickets, users, organizations):
+
 .. code-block:: ruby
 
-   # Remove all online notifications
-   >> OnlineNotification.destroy_all
+   RecentView.destroy_all
 
-   # Remove all entries from the Activity Stream (dashboard)
-   >> ActivityStream.destroy_all
+Remove all history information from tickets, users and organizations
+(dangerous!):
 
-   # Remove entries for all recently viewed objects
-   # (tickets, users, organizations)
-   >> RecentView.destroy_all
+.. code-block:: ruby
 
-   # Remove all history information from tickets, users and organizations
-   # (dangerous!)
-   >> History.destroy_all
+   History.destroy_all
 
 .. _dangerzone_reset_zammad:
 
@@ -133,7 +153,16 @@ Reset Zammad Installation
 
 .. code-block:: sh
 
-   $ rake db:drop
-   $ rake db:create
-   $ rake db:migrate
-   $ rake db:seed
+   rake db:drop
+
+.. code-block:: sh
+
+   rake db:create
+
+.. code-block:: sh
+
+   rake db:migrate
+
+.. code-block:: sh
+
+   rake db:seed