rhaas3/internal-documentation
1
0
Fork 0
forked from docs/internal-documentation
Code Pull Requests Activity

Fixing the image references

Browse Source 
Reviewed-by: otcbot <otcbot@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
This commit is contained in:
Hasko, Vladimir 2024-10-08 14:49:28 +00:00 committed by zuul
parent 3666984377
commit 516445ee34
7 changed files with 68 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/status_dashboard/SDMoD/look&feel_after/new_incident.rst
View File

@ -4,7 +4,7 @@ Create a new incident
After the login, the menu bar looks like the following: After the login, the menu bar looks like the following:
.. image:: ../images/menu2.png .. image:: ../images/menu2.png
:target: ../images/menu2.png :target: /_images/menu2.png
:alt: Menu after login :alt: Menu after login
There is an additional option, which is called “Open new incident” There is an additional option, which is called “Open new incident”
@ -12,7 +12,7 @@ There is an additional option, which is called “Open new incident”
If you click on it, the following view will appear: If you click on it, the following view will appear:
.. image:: ../images/inc1.png .. image:: ../images/inc1.png
:target: ../images/inc1.png :target: /_images/inc1.png
:alt: Overview New incident :alt: Overview New incident
@ -81,7 +81,7 @@ Explanation of additional fields and options for Incident Impact “Scheduled Ma
For a maintenance, the view looks like as follows: For a maintenance, the view looks like as follows:
.. image:: ../images/inc2.png .. image:: ../images/inc2.png
:target: ../images/inc2.png :target: /_images/inc2.png
:alt: New Incident - details :alt: New Incident - details
In addition to the ones explained above, you have the following fields: In addition to the ones explained above, you have the following fields:
@ -108,13 +108,13 @@ How to adjust a minor/major incident or an outage?
An incident will look like as follows: An incident will look like as follows:
.. image:: ../images/public_inc1.png .. image:: ../images/public_inc1.png
:target: ../images/public_inc1.png :target: /_images/public_inc1.png
:alt: published Incident :alt: published Incident
By clicking the title (in the example above “Service Impact on ECS”, you can edit/update the incident. The view will look like as follows: By clicking the title (in the example above “Service Impact on ECS”, you can edit/update the incident. The view will look like as follows:
.. image:: ../images/inc3.png .. image:: ../images/inc3.png
:target: ../images/inc3.png :target: /_images/inc3.png
:alt: Adjust Incident :alt: Adjust Incident
@ -153,7 +153,7 @@ Go to the Menu, Event History and select the corresponding Incident.
.. image:: ../images/inc4.png .. image:: ../images/inc4.png
:target: ../images/inc4.png :target: /_images/inc4.png
:alt: Adjust Incident :alt: Adjust Incident
@ -171,7 +171,7 @@ In case an issue will come back, for example, you can reopen the incident.
The Message will also be back on status dashboard and look like as follows: The Message will also be back on status dashboard and look like as follows:
.. image:: ../images/inc5.png .. image:: ../images/inc5.png
:target: ../images/inc5.png :target: /_images/inc5.png
:alt: Reopen Incident :alt: Reopen Incident
Incident changed: (end date has been changed) Incident changed: (end date has been changed)
@ -181,11 +181,11 @@ In case a minor or major issue occured and was triggered by the system, the end
**Example:** A minor incident occured during the night and the SDMoD do take care of it during the next business hours, the end date can be adjusted accordingly. **Example:** A minor incident occured during the night and the SDMoD do take care of it during the next business hours, the end date can be adjusted accordingly.
.. image:: ../images/inc6.png .. image:: ../images/inc6.png
:target: ../images/inc6.png :target: /_images/inc6.png
:alt: Adjust end date of an inc :alt: Adjust end date of an inc
This will also be mentioned in the change log of the incident publicly: This will also be mentioned in the change log of the incident publicly:
.. image:: ../images/inc_change.png .. image:: ../images/inc_change.png
:target: ../images/inc_change.png :target: /_images/inc_change.png
:alt: Changelog Incident :alt: Changelog Incident

2
doc/source/status_dashboard/SDMoD/look&feel_before/look&feel_before.rst
View File

@ -4,7 +4,7 @@ The look & feel before login
Before logging-in, the screen will look like as follows: Before logging-in, the screen will look like as follows:
.. image:: ../images/look&feel_before.png .. image:: ../images/look&feel_before.png
:target: ../images/look&feel_before.png :target: /_images/look&feel_before.png
:alt: Look&Feel :alt: Look&Feel
There are various options, which will be explained in the next chapters. There are various options, which will be explained in the next chapters.

2
doc/source/status_dashboard/SDMoD/look&feel_before/menu/component_availability.rst
View File

@ -12,6 +12,6 @@ The component availability is impacted by the following status:
| Icon | Explanation | | Icon | Explanation |
+======================================+==============================================================================+ +======================================+==============================================================================+
| .. image:: ../../images/outage.png | see explanation :ref:`Status of Services <status_services>` | | .. image:: ../../images/outage.png | see explanation :ref:`Status of Services <status_services>` |
| :target: ../../imags/outage.png | | | :target: /_images/outage.png | |
| :alt: Outage | | | :alt: Outage | |
+--------------------------------------+------------------------------------------------------------------------------+ +--------------------------------------+------------------------------------------------------------------------------+

2
doc/source/status_dashboard/SDMoD/look&feel_before/menu/event_history.rst
View File

@ -9,5 +9,5 @@ https://status.otc-service.com/history
An example is: An example is:
.. image:: ../../images/event_history.png .. image:: ../../images/event_history.png
:target: ../../images/event_history.png :target: /_images/event_history.png
:alt: Event History :alt: Event History

51
doc/source/status_dashboard/SDMoD/look&feel_before/menu/menu.rst
View File

@ -2,7 +2,7 @@ The menu
--------------------------------------- ---------------------------------------
.. image:: ../../images/menu.png .. image:: ../../images/menu.png
:target: ../../images/menu.png :target: /_images/menu.png
:alt: The menu :alt: The menu
The menu includes: The menu includes:
@ -17,3 +17,52 @@ The menu includes:
| User Manual | Link to the actual version of the user manual. | | User Manual | Link to the actual version of the user manual. |
+---------------------------------+------------------------------------------------------------------------------+ +---------------------------------+------------------------------------------------------------------------------+
----------
Event history
~~~~~~~~~~~~~~~~~~~~~~~~~
The event history shows all past events, sorted by months.
A direct link exists:
https://status.otc-service.com/history
An example is:
.. image:: ../../images/event_history.png
:target: /_images/event_history.png
:alt: Event History
----------
Component Availability
~~~~~~~~~~~~~~~~~~~~~~~~~
The component availability shows the availability of each service each month.
The services are categorized and split between eu-de and eu-nl.
The availability page is also directly reachable via https://status.otc-service.com/availability
The component availability is impacted by the following status:
+--------------------------------------+------------------------------------------------------------------------------+
| Icon | Explanation |
+======================================+==============================================================================+
| .. image:: ../../images/outage.png | see explanation :ref:`Status of Services <status_services>` |
| :target: /_images/outage.png | |
| :alt: Outage | |
+--------------------------------------+------------------------------------------------------------------------------+
----------
User Manual
~~~~~~~~~~~~~~~~~~~~~~~~~
The user manual can also be reached directly via the following link:
https://docs.otc.t-systems.com/status-dashboard/index.html

2
doc/source/status_dashboard/SDMoD/look&feel_before/regions_switch.rst
View File

@ -4,5 +4,5 @@ Switch between regions
Clients can easily switch between the services and check their availability by clicking the region: Clients can easily switch between the services and check their availability by clicking the region:
.. image:: ../images/region_switch.png .. image:: ../images/region_switch.png
:target: ../images/region_switch.png :target: /_images/region_switch.png
:alt: Switch regions :alt: Switch regions

10
doc/source/status_dashboard/SDMoD/look&feel_before/status_services.rst
View File

@ -10,22 +10,22 @@ The services can vary between the following status:
| Icon | Explanation | | Icon | Explanation |
+======================================+==============================================================================+ +======================================+==============================================================================+
| .. image:: ../images/green.png | - All services are running fine | | .. image:: ../images/green.png | - All services are running fine |
| :target: ../imags/green.png | | | :target: /_imags/green.png | |
| :alt: Operational | | | :alt: Operational | |
+--------------------------------------+------------------------------------------------------------------------------+ +--------------------------------------+------------------------------------------------------------------------------+
| .. image:: ../images/blue.png | - A maintenance is planned or ongoing for a service | | .. image:: ../images/blue.png | - A maintenance is planned or ongoing for a service |
| :target: ../imags/blue.png | - A maintenance is triggered by the SDMoD | | :target: /_imags/blue.png | - A maintenance is triggered by the SDMoD |
| :alt: Maintenance | | | :alt: Maintenance | |
+--------------------------------------+------------------------------------------------------------------------------+ +--------------------------------------+------------------------------------------------------------------------------+
| .. image:: ../images/yellow.png | - A minor issue occurred. The service is available but may have restrictions | | .. image:: ../images/yellow.png | - A minor issue occurred. The service is available but may have restrictions |
| :target: ../imags/yellow.png | or slow response. | | :target: /_imags/yellow.png | or slow response. |
| :alt: Minor Issue | - A minor issue can either be triggered by the system autoamtically or | | :alt: Minor Issue | - A minor issue can either be triggered by the system autoamtically or |
| | by SDMoD | | | by SDMoD |
| | | | | |
| | | | | |
+--------------------------------------+------------------------------------------------------------------------------+ +--------------------------------------+------------------------------------------------------------------------------+
| .. image:: ../images/red.png | - A major issue occurred. The service may be available, but the | | .. image:: ../images/red.png | - A major issue occurred. The service may be available, but the |
| :target: ../imags/red.png | responsiveness is affected and may lead to interruptions on customer side. | | :target: /_imags/red.png | responsiveness is affected and may lead to interruptions on customer side. |
| :alt: Major Issue | - A major issue can either be triggered by the system autoamtically or by | | :alt: Major Issue | - A major issue can either be triggered by the system autoamtically or by |
| | SDMoD | | | SDMoD |
| | | | | |
@ -33,7 +33,7 @@ The services can vary between the following status:
| | | | | |
+--------------------------------------+------------------------------------------------------------------------------+ +--------------------------------------+------------------------------------------------------------------------------+
| .. image:: ../images/outage.png | - A service is not available anymore at all. | | .. image:: ../images/outage.png | - A service is not available anymore at all. |
| :target: ../imags/outage.png | - An outage can **only** be triggered by SDMoD. This will never happen | | :target: /_imags/outage.png | - An outage can **only** be triggered by SDMoD. This will never happen |
| :alt: Outage | automatically by the system | | :alt: Outage | automatically by the system |
| | - **Only** outages are SLA relevant and do have impact to the component | | | - **Only** outages are SLA relevant and do have impact to the component |
| | availability | | | availability |