Skip to content

Commit

Permalink
improve documentation and apply code review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephan Krusche committed Apr 28, 2024
1 parent 03aa25f commit 356d55c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 12 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Artemis offers a build queue view that shows the all running, queued and finished build jobs.
The build queue of all build jobs is accessible only to **Administrators** and is accessible via the *System Administration* menu.
Artemis provides a build queue view that displays all queued, running, and finished build jobs. Access to the system-wide build queue is
exclusively available to **Administrators** through the *System Administration* menu.

.. figure:: programming/buildQueueSystemAdministration.png
:alt: Build Queue System Administration
:align: center

Build Queue System Administration

The build queue for a specific course is also accessible to **Instructors** via the *Build Queue* menu in the *Course Management* menu
and shows only the build jobs for the selected course.
**Instructors** can access the build queue for a specific course through the *Build Queue* button located in *Course Management*.
This view displays only the queued, running, and finished build jobs associated with the selected course.

.. figure:: programming/buildQueueCourseManagement.png
:alt: Build Queue Course Management
Expand All @@ -18,11 +18,14 @@ and shows only the build jobs for the selected course.

The build queue view is divided into three sections:



Running Build Jobs
""""""""""""""""""
The running build jobs section shows all build jobs that are currently running.
New build jobs are added and removed from the queue in real-time and can be cancelled by the user.
The table shows the following information:
The "Running Build Jobs" section displays all build jobs currently being executed by a build agent.
Jobs are dynamically added to and removed from the queue in real-time.
Users have the ability to cancel any job in progress. The table provides the following information:


.. figure:: programming/running-build-jobs.png
:alt: Running Build Jobs
Expand All @@ -34,19 +37,27 @@ The table shows the following information:

Queued Build Jobs
""""""""""""""""""
The queued build jobs section shows all build jobs that are currently queued. New build jobs are added and removed from the queue in real-time and can be cancelled by the user.
The table shows the following information:
The "Queued Build Jobs" section lists all build jobs currently awaiting execution.
Jobs are continuously added to and removed from the queue in real-time.
Users also have the option to cancel any job that is queued.
The table below displays the following information:


.. figure:: programming/queued-build-jobs.png
:alt: Queued Build Jobs
:align: center

Queued Build Jobs



Finished Build Jobs
"""""""""""""""""""
The finished build jobs section shows all build jobs that have finished (successfully with or without a result, failed or cancelled).
The finished build jobs are fetched gradually as the user navigates through the pages. The table shows the following information:
The "Finished Build Jobs" section displays all build jobs that have concluded, whether successfully completed, with or without a result, failed, or cancelled.
Information about finished build jobs is progressively loaded as the user navigates through the pages.
Instructors can also access build logs with detailed information about the build execution by clicking on **View build logs**. This is particularly helpful for failed builds.
The table provides the following information:


.. figure:: programming/finished-build-jobs.png
:alt: Finished Build Jobs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export const ITEMS_PER_PAGE = 5;
export const ITEMS_PER_PAGE = 50;
export const ASC = 'asc';
export const DESC = 'desc';
export const SORT = 'sort';

0 comments on commit 356d55c

Please sign in to comment.