ikvrivis/docsportal_forked
1
0
Fork 0
forked from docs/docsportal
Code Pull Requests Activity

enrolling requested changes

Browse Source
This commit is contained in:
YustinaKvr 2023-07-04 18:53:15 +02:00
parent e597f9ed28
commit 82bbbabc0d
1 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/internal/helpcenter_training/dashboards/index.rst
View File

@ -7,13 +7,13 @@ repository for all user and customer related documentation of the
set of GitOps processes, that makes writing, reviewing, releasing, and set of GitOps processes, that makes writing, reviewing, releasing, and
updating documentation transparent. Core components of the Helpcenter updating documentation transparent. Core components of the Helpcenter
are Git repositories, a rendering engine that transforms restructured are Git repositories, a rendering engine that transforms restructured
text into several formats including HTML and PDF, a powerful serach text into several formats including HTML and PDF, a powerful searach
engine, and a webserver delivering the content to the users. engine, and a webserver delivering the content to the users.
To maintain a continous overview of the documents, their status, To maintain a continous overview of the documents, their status,
pending changes, or reported issues, a comprehensive status dashboard pending changes, or reported issues, a comprehensive status dashboard
has been introduce, leveraging Grafana for improved visibilityof the has been introduce, leveraging Grafana for introduced visibility of the
associated processes. This is this dashboard's documentation. associated processes.
This comprehensive mechanism continously tracks and evaluates the This comprehensive mechanism continously tracks and evaluates the
progress of the documentation process from the pre-production stage in progress of the documentation process from the pre-production stage in
@ -38,7 +38,7 @@ steps:
The components for all steps are hosted in the Open Telekom Cloud The components for all steps are hosted in the Open Telekom Cloud
environment. The dashboard is a web based application at environment. The dashboard is a web based application at
https://dashboard.helpcenter.otc-service.com/ https://dashboard.tsi-dev.otc-service.com/
Dashboards and Panels: What They Are and What They're For Dashboards and Panels: What They Are and What They're For
@ -49,25 +49,20 @@ data at a glance. It aggregates and presents key insights derived from
multiple data sources into a cohesive and easily digestible multiple data sources into a cohesive and easily digestible
format. For the Helpcenter three dashboards are available: format. For the Helpcenter three dashboards are available:
* **Open PRs Dashboard:** This dashboard focuses on monitoring open * `Open PRs Dashboard: <https://dashboard.tsi-dev.otc-service.com/d/4vLGLDB4z/open-prs-dashboard?orgId=1>`_ This dashboard focuses on monitoring open
Pull Requests (PRs) in the pre-production (Gitea) stage, as well as Pull Requests (PRs) in the pre-production (Gitea) stage, as well as
orphaned PRs. Orphaned PRs occur when XXXXX during the transfer of orphaned PRs. Orphaned PRs arise when the parent PR of a child PR remains in an open status (or vice versa) during the transition of a PR from the preprod to the prod repository. Orphaned PRs occurs also when either parent PR (doc-exports) is merged and child PR (target doc repository) is still not merged or when parent PR is not merged but child PR is merged. If Orphaned PRs are not dealed properly such situation can lead to potential conflicts in future, broken PRs and even to revert PRs. The dashboard
an PR from the preprod to the prod repository. The dashboard
provides an overview of the PR's status, helping to identify provides an overview of the PR's status, helping to identify
bottlenecks and ensuring the smooth progression of documentation whether there are any orphaned PRs or not, and ensuring the smooth progression of documentation
workflows. workflows.
* **Open Issues Dashboard:** This dashboard is specifically designed * `Open Issues Dashboard: <https://dashboard.tsi-dev.otc-service.com/d/I-YJAuBVk/open-issues-dashboard?orgId=1>`_ This dashboard is specifically designed
to track and manage open issues across different services and to track and manage open issues across different services and
squads. It presents data derived from a Postgres database, offering squads. It presents data derived from a Postgres database, offering
insights into the distribution of issues and helping squads insights into the distribution of issues and helping squads
prioritize their work. prioritize their work. The data originates from multiple sources, including Github and Gitea, thereby capturing a full scope of issues being addressed by various groups such as Squads, TSI management, Community members, and Customers. This enhanced visibility aids squads in prioritizing their work, ensuring a swift and effective resolution of issues.
* **Last Release Dashboard:** An essential tool for tracking updates * `Last Release Dashboard: <https://dashboard.tsi-dev.otc-service.com/d/c67f0f4b-b31c-4433-b530-a18896470d49/last-docs-commit?orgId=1>`_ Its primary purpose is to maintain up-to-date and compliant documentation for all services. It visualizes the elapsed time since the last update was made to each service's documentation, thereby highlighting those services that haven't been updated in a timely manner. Any documentation that hasn't been updated for a period exceeding 365 days is brought to attention, highlighted in red on the dashboard. This prompt helps identify outdated documentation, and alerts for these are sent to the respective squads via Zulip for immediate action. By monitoring the frequency of updates, this dashboard aids in ensuring the relevance, accuracy, and compliance of the service documentation.
of specific documentats, the *Last Release Dashboard* visualizes the
time passed since the last change for a service. Monitoring the
update frequency aids ensuring the relevancy and timeliness of the
documents.
Open PRs Dashboard Open PRs Dashboard
@ -159,7 +154,7 @@ panels:
shows the total count of open issues across all environments and shows the total count of open issues across all environments and
squads. It provides an overarching view of all open issues, squads. It provides an overarching view of all open issues,
irrespective of their source. Count of issues might be filtered with irrespective of their source. Count of issues might be filtered with
drpo-down list *Squad*. drop-down list *Squad*.
* **Github count of issues:** like the Gitea panel, this gauge * **Github count of issues:** like the Gitea panel, this gauge
displays the number of open issues in the Github environment, displays the number of open issues in the Github environment,