RHDEVDOCS-2330: Enhancements to starting pipelines via Topology #42871
Conversation
openshift-ci
bot
added
the
size/M
|
|
| . On the left navigation panel, click *Topology*, and click on the application to see the pipeline runs listed in the side panel. | ||
| . In the *Pipeline Runs* section, click *Start Last Run* to start a new pipeline run with the same parameters and resources as the previous one. This option is disabled if a pipeline run has not been initiated. You can also opt-in to starting the pipeline during the creation process itself. | ||
| + | ||
| .Pipelines in Topology view |
There was a problem hiding this comment.
Should this be a separate concept or procedure module?
There was a problem hiding this comment.
It's just a procedure which has been refactored inside a new one.
There was a problem hiding this comment.
@rolfedh This adds an image caption along with the figure number. Here is the preview: https://deploy-preview-42871--osdocs.netlify.app/openshift-enterprise/latest/cicd/pipelines/working-with-pipelines-using-the-developer-perspective#op-starting-pipelines_from_topology_viewusing-custom-pipeline-template-for-git-import
There was a problem hiding this comment.
Please let me know if I have misunderstood anything.
| ==== | ||
| The side panel of the application node in the *Topology* page displays a *Log Snippet* when a pipeline run fails on a specific task run. You can view the *Log Snippet* in the *Pipeline Runs* section, under the *Resources* tab. *Log Snippet* provides a general error message and a snippet of the log. A link to the *Logs* section provides quick access to the details about the failed run. | ||
| ==== | ||
| . If a Pipeline run does not start automatically, the side panel displays a message that the pipeline cannot be automatically started. On the other hand, if a Pipeline is created but the user has not started the pipeline, its status is not started. When the user clicks the not started status icon, the start dialog box opens in the *Topology* view. |
There was a problem hiding this comment.
This is descriptive information, not a step a user can perform. Please remove the numbering. The step on line 24 also seems informational.
Consider splitting everything from line 21 and down into a separate conceptual topic and present this information as a series of bullet points. What do you think?
There was a problem hiding this comment.
Following the Mod Doc standard for content types is an important OKR. I think fixing this issue is important for us to comply with the Mod Docs standard.
There was a problem hiding this comment.
@rolfedh Can you please have a look and see if all looks correct?
| image::op_pipeline_topology.png[Pipelines in Topology view] | ||
| + | ||
| . In the *Topology* page, hover to the left of the application to see the status of its pipeline run. | ||
| . After a pipeline is added, a bottom left icon indicates that there is an associated pipeline. |
There was a problem hiding this comment.
This is not a user action. Should it be a step?
| ==== | ||
| The side panel of the application node in the *Topology* page displays a *Log Snippet* when a pipeline run fails on a specific task run. You can view the *Log Snippet* in the *Pipeline Runs* section, under the *Resources* tab. *Log Snippet* provides a general error message and a snippet of the log. A link to the *Logs* section provides quick access to the details about the failed run. | ||
| ==== | ||
| . If a Pipeline run does not start automatically, the side panel displays a message that the pipeline cannot be automatically started. |
There was a problem hiding this comment.
This is not a user action. Should it be a step?
| The side panel of the application node in the *Topology* page displays a *Log Snippet* when a pipeline run fails on a specific task run. You can view the *Log Snippet* in the *Pipeline Runs* section, under the *Resources* tab. *Log Snippet* provides a general error message and a snippet of the log. A link to the *Logs* section provides quick access to the details about the failed run. | ||
| ==== | ||
| . If a Pipeline run does not start automatically, the side panel displays a message that the pipeline cannot be automatically started. | ||
| . If a Pipeline is created but the user has not started the pipeline, its status is not started. When the user clicks the not started status icon, the start dialog box opens in the *Topology* view. |
There was a problem hiding this comment.
This is not a user action. Should it be a step?
| . Click the application to display *Pipeline Runs* in the side panel. | ||
| . In *Pipeline Runs*, click *Start Last Run* to start a new pipeline run with the same parameters and resources as the previous one. This option is disabled if a pipeline run has not been initiated. You can also start a pipeline run when you create it. | ||
| + | ||
| .Pipelines in Topology view |
There was a problem hiding this comment.
Disregard this comment: "Is this really a procedure. It doesn't seem like one."
There was a problem hiding this comment.
I apologize. Looking at the preview, I realize that I misunderstood completely what you were doing.
HarshCasper
force-pushed
the
RHDEVDOCS-2330
branch
2 times, most recently
from
2a00b5e
to
cb4ad1d
Compare
Preeticp
added
branch/enterprise-4.10
Dev Tools
|
/cherrypick enterprise-4.10 |
|
@Preeticp: new pull request created: #42917 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
This PR is for the 4.10 release.