Preparing to Start a Version Generation Job
Before you start a new generation run in Atloria, open your project and go to the Versions area. This is the workspace where you manage documentation versions and start a new one. Look for the action that creates a version, such as New Version or Generate Version. If you have already worked through Comparing Version Output and Release Readiness, use the same version workspace so you are starting from the correct project and release context.
On the version creation screen, review every field before you submit. Atloria may ask for a version label, an internal identifier, a source selection, and other generation settings. Pay close attention to the version name and any source choice that points to the content you want to generate from, such as the selected branch, content set, or saved source snapshot. If the form includes a template, preset, or generation option, confirm that it matches the type of output you want to produce.
Use the form as a final readiness check. If Atloria shows fields such as Title, Slug, or an output destination, fill them in carefully because these values affect how the generated version is identified later. Also review any default options related to review or publishing so you do not accidentally send an unfinished version further down the release process.
Before clicking the submit button, make sure the current documentation is in a stable state:
- Resolve draft edits that should be included in this run
- Check for missing pages in the document structure
- Review any warnings shown on the version form
- Confirm screenshots or assets needed for this version are already available
- Make sure you are generating from the intended source
Starting a New Documentation Version
-
Open your project in Atloria and go to Versions.
-
Click New Version or Generate Version to open the version creation form.
-
Enter the version details shown on the form. Atloria may present fields similar to the following:
| Field | What to check |
|---|---|
| Version Label | Use the name reviewers will recognize in the Versions list |
| Internal Identifier | Confirm it matches your team’s naming pattern |
| Source | Choose the correct branch, content set, or source snapshot |
| Title | Make sure the displayed title is accurate |
| Slug | Check that the version slug is correct and consistent |
| Output Target | Verify the destination for the generated output |
-
Review any inclusion options before you continue. If Atloria offers settings that control what gets regenerated, check whether the run should include rendered pages, navigation, assets, search-related output, or derived documentation pages. A missed option here can lead to a version that looks incomplete even when the job finishes successfully.
-
Look over the full form one more time. This is the best moment to catch an incorrect source selection or a version name that does not match the release you are preparing.
-
Submit the form to start the generation job.
Right after submission, return to the Versions list or the job detail view and note the first status Atloria shows. Depending on timing, the job may appear as Queued, Pending, or Running. That first status matters because it tells you whether Atloria accepted the request and placed it into the generation pipeline.
Monitoring Job Progress While Generation Runs
-
After you submit the version, stay in the Versions area or open the version’s detail page to watch the job status.
-
Check the status label first. In Atloria, a generation run typically moves through a short sequence such as Queued, In Progress, Completed, or Failed. If the label changes from a waiting state to an active state, the run has started.
-
Review the progress details shown on the screen. Atloria may display indicators such as:
- Percentage complete
- Current stage
- Started at
- Finished at
- Duration
These fields help you tell the difference between a job that is still moving and one that may be stuck.
-
Open the activity details, results panel, or job log if that option is available on the page. This is where you can see which step Atloria is currently working on, such as content generation, asset processing, validation, or output packaging.
-
Refresh the page or reopen the version detail screen if the status has not changed for a while. A fresh page load helps confirm whether the run is still active or whether the last visible update is simply old.
-
Stop monitoring only when the job reaches a final state. In practice, that means:
- Completed: the output is ready to inspect
- Failed: the run stopped and needs attention
- Completed with warnings or a similar result panel: the version exists, but you still need to review issues
If you are tracking several releases at once, compare the Started at and Duration values across jobs so you can spot unusual delays more quickly.
Reviewing the Generated Version Output
-
Open the completed version from the Versions list or from the finished job record.
-
Start with the version summary. Check the visible metadata Atloria shows for the generated result, including the version name, the generation time, the source used for the run, and any job reference shown on the page. This confirms you are reviewing the correct output and not an older version with a similar name.
-
Locate the generated output areas. Depending on what is available in your project, this may include rendered pages, navigation structure, and processed assets. Review the navigation first because it quickly shows whether major sections were included.
-
Open the validation or results panel and read every warning. Atloria may flag issues such as:
- Broken links
- Missing references
- Skipped files
- Content that could not be rendered
A version can still finish even when these warnings appear, so do not assume Completed means everything is ready for review.
-
Use any preview action available on the version to inspect the output before handing it off. Spot-check several page types rather than reading only the home page. Open a few top-level pages, confirm child pages appear in the navigation, and verify that screenshots or other assets display where expected.
-
Compare what you see against the source you intended to generate. If section names, page order, or visible content look older than expected, pause before sending the version to reviewers.
This stage is about confidence, not deep approval. You are confirming that the generated version is complete enough to move forward.
Deciding Whether to Regenerate or Move to Review
Once you finish checking the output, use the final result state in Atloria to decide what happens next. A version that shows Completed with no visible issues is usually ready for reviewer handoff. A version that shows Completed but includes warnings needs a closer judgment call. A version marked Failed should not move forward until you correct the problem and run it again.
Use the result details, not just the status badge, to make that decision. If the warnings involve missing assets, the wrong source selection, incomplete navigation, or pages that did not render, start another generation run after correcting the inputs. These problems affect what reviewers see and can waste review time. On the other hand, if the version finished and the warnings are minor, you may decide the output is still suitable for review, especially if the issues do not block page reading or release comparison.
A full rerun is usually the better choice when you notice:
- The wrong branch, content set, or source snapshot was used
- Important pages are missing from navigation
- Assets did not process correctly
- The generated content is clearly outdated
- Validation errors affect key pages
You may still move to review when:
- The version output is complete and readable
- Warnings are limited and understood
- Reviewers only need to assess content changes, not final release quality
Before handing the version to reviewers, record the details they may need:
- Version label or identifier
- Generation date and time
- Source used
- Any warnings attached to the run
- Whether this is the preferred output for review
For the formal comparison step that follows generation, continue with Comparing Documentation Versions for Release Decisions.
Fixing Common Generation Problems
When a generation run does not behave as expected, start with the status shown in the Versions area and then open the job details for more context.
If the job stays in Queued or Pending, first check whether Atloria offers a retry action in the job menu. Then reopen the version details and confirm that all required fields were completed when you created the run. An incomplete title, slug, source choice, or output setting can lead to a job that never moves cleanly into processing. If retry is available, use it after confirming the inputs.
If the run fails during validation, read the error list carefully. Atloria may point to broken links, missing files, unsupported content, or invalid metadata in the selected source. Focus on the items that block rendering or remove important pages from the output. After you correct those issues in the source content, start a fresh generation run instead of relying on the failed result.
If the version completes but pages or assets are missing, return to the generation settings you used. Confirm that the correct source was selected and that the run included the options needed for assets and navigation. A version can finish successfully while still excluding content because of the choices made on the form.
If the output looks outdated or incorrect, compare the version details against the source you intended to use. In many cases, the issue is simply that the wrong branch, content snapshot, or preset was selected before submission. Correct the source and regenerate.
Helpful checks when troubleshooting:
- Compare the current run with the last successful version
- Re-read the version metadata before retrying
- Confirm the version name matches the release you intended
- Review warnings even when the job says Completed
Overview
Managing version generation jobs in Atloria means following the full path from version setup to finished output. You begin in the Versions area, create a new version, submit the generation job, monitor its progress, and then inspect the result before anyone starts formal review. This document focuses on that operational work: what to click, what statuses to watch, and how to decide whether the result is usable.
The most important screens are the Versions list, the version creation form, the job or version detail page, and the generated version preview. Together, these screens tell you whether Atloria accepted the run, what source was used, how far the job has progressed, and whether the final output includes the pages, navigation, and assets you expected.
As you work, pay attention to visible status changes such as Queued, In Progress, Completed, and Failed. Also watch for result panels and warning messages. A finished job is not always a ready job. Atloria can complete a generation run while still reporting broken links, missing references, or skipped content, so the review step starts with checking the output quality yourself.
This guide does not repeat the earlier readiness evaluation covered in Comparing Version Output and Release Readiness. Instead, it shows how to manage the generation run itself and how to interpret the result once Atloria finishes processing it. The goal is simple: make sure the version you pass forward is the right one, generated from the right source, with issues understood before review begins.
Prerequisites
Before you manage a version generation job in Atloria, make sure the project and version workspace are already in a usable state. You do not need deep administrative setup for this task, but you do need access to the project’s Versions area and the ability to open the version creation form.
Check these items before you begin:
- You can sign in to Atloria and open the correct project
- The project already has documentation content ready to generate
- You can access the Versions area for that project
- The New Version or Generate Version action is available to you
- You know which source should be used for this run, such as the correct branch or content set
- You have the version naming details your team expects, including the visible version label and any internal identifier
- Any required pages, screenshots, or assets for this release have already been added
- You are ready to review warnings and rerun the job if needed
It also helps if you have already completed these related guides:
If you need help getting into Atloria or confirming your access, use Accessing and Registering Your Atloria Account or Signing In to Atloria and Solving Access Problems.
Once these basics are in place, you can create a version, follow the generation job through to completion, and decide whether the result should be regenerated or sent on for comparison and review.
Was this page helpful?