Documentation job status reference

Documentation job statuses at a glance

A documentation job status tells you where a documentation generation run stands and which follow-up action belongs next. Use this page when you need to read a status on a project’s Activity & Jobs surface or in Operations.

The project Activity & Jobs surface is the canonical list for a project’s background documentation runs. The Operations surface also presents recent jobs with their status, stage, document count, duration, and error information. A documentation generation lifecycle has its own stage sequence; use Documentation generation lifecycle when you need that sequence rather than a status lookup.

Before you check a job status

Before reading a status, decide whether you are checking one project’s activity or the wider recent-job view in Operations.

Prerequisites

• Know the project whose runs you want to review when using the project job surface.
• Open Activity & Jobs for the project whose runs you want to review.
• Open Operations when you need the recent-job view.

With the view identified, locate the job in the next section.

Find the job status

Choose the project surface for one project’s activity or Operations for the recent-job table.

Steps

1. Choose one view:

   If you want to…	Open
   Review runs for one project	Open the project’s Activity & Jobs view
   Review recent jobs across the operational view	Open Operations

2. In the project view, use Recent Jobs to locate the run’s status.

3. In Operations, use Recent jobs and read the value in its Status column.

4. Select Refresh to request the current list again.

While the project list is being refreshed, the action label changes to Refreshing….

Result: The selected job list is on screen, and you can read the status from the project Recent Jobs area or the Status column in Recent jobs.

Interpret the status and progress details

Read the current status on the project surface as Completed, Failed, Running, Pending, or Cancelled.

Running and Pending are the active statuses. An active row can show the current stage and percentage. When live progress is available, it can also show the current item, elapsed time, and estimated remaining time. When live progress is not available, the row uses the job’s basic stage and percentage instead.

The Operations view presents recent jobs in a table. Read When for the recorded time, Status for the job status, Stage for the current stage, Docs for the document count, Duration for the elapsed run time, and Error for error text.

In Operations, Completed uses the success chip and Failed uses the error chip. Other status values use the warning fallback in that table.

With the status and its details read, choose the action that matches the row’s current state.

Respond to a job's status

The actions available for a row depend on its status. Choose an action that matches the row’s current state.

Refresh the job list

Prerequisites

The project job list is open.

Steps

1. Select Refresh.

The label changes to Refreshing… while the list is loading.

Result: The project job list remains on screen with the refreshed loading state, then returns to the list when loading finishes.

Cancel an active job

Prerequisites

The job is Running or Pending, and the row provides Cancel.

Steps

1. Select Cancel on the active job row.
2. Select Are you sure? to confirm the cancellation.

While cancellation is being processed, the action label is Cancelling....

Result: The active job has received the cancellation request, and its status can be reviewed again in the job list.

Delete documents from a finished job

Prerequisites

The job is Completed, Failed, or Cancelled, and the row provides Delete <n> Docs or Delete Job.

Steps

1. Select one control on the row:

   If the job has…	Select
   Created documents	Delete <n> Docs
   No created documents	Delete Job

2. Select Confirm Delete? when the confirmation label appears.

The action label is Delete <n> Docs when the job has created documents; otherwise it is Delete Job.

Result: The delete request has been sent for the selected finished job.

Continue from a completed result

Prerequisites

The job is Completed, and its row can expand.

Steps

1. Open the completed job row.

2. Select one available action:

   If you need to…	Select
   Review flagged documents before publishing	Review & Publish
   Open documentation when a published URL is available	View Published Documentation
   Open documentation through the project fallback	View Documentation
   Copy the public documentation address	Copy Public URL
   Start another generation	Generate Again

Result: The selected completion action opens its corresponding documentation, review, address-copy, or generation path.

If the list instead shows a loading or failure message, use the table in the next section.

When status information does not load

The job surfaces use different messages for initial loading, an empty project list, an empty history, a failed refresh, and a failed job. Match the message on screen to the action in the table.

When a stalled run’s progress remains quiet past the inactivity threshold, the project surface describes it as reconciled to Failed. Read the failed row’s details rather than treating it as an active run.

After resolving the status message, continue with the work that follows from the run’s state.

What to do next

After you interpret the status, continue according to the work you need to do:

• Start or monitor documentation work in Run documentation work.
• Follow the generation stages in Documentation generation lifecycle.
• Review the wider operational work areas in Operations overview.
• Review past operational work in Job History.

If a stalled run is shown as Failed, use the failed-row details and then follow the generation or history path that matches your next task.