openshift / pipelines-docs Goto Github PK

Describe the Bug

There is a mismatch between the example pipeline content in the docs and the version on github. The content in the docs has a single string value for the ARGS parameter, whereas the github content in pipelines-tutorial has an array.

Steps to Reproduce

1. Copy the content in Assembling a pipeline into a YAML file.
2. Create/apply the pipeline YAML
3. Start a pipeline run as specified in Triggering and Running a Pipeline

Expected Behavior

Pipeline runs successfully.

Actual Behavior

Pipeline fails to run due an invalid value for the ARGS parameter.

Describe the Bug
When going through "Creating applications with CI/CD Pipelines" on the "Procedure" oc create -f ... steps it returns a 404 (page not found.)

Steps to Reproduce

1. Follow the steps in the "Creating applications with CI/CD Pipelines" guide, up to this step:

oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/pipeline/update_deployment_task.yaml

Expected Behavior
The oc apply -f ... command should succeed.

Additional context
Broken links are here

Describe the Bug

The docs for pipelines v0.7.0 include raw github links to the master branch of openshift/pipelines-tutorial. These break as the project evolves.

Steps to Reproduce

1. Visit the v0.7.0 docs pages
2. Walk through the tutorial
3. Try doing the following
   1. Assembling a pipeline - create the pipeline from the github link [1]
   2. Defining resources - create resources from the github link [2]
   3. Deploying an application - create resources from the github link [3]

Expected Behavior

Links are not broken and content can be used by oc create -f.

Additional context

[1] https://openshift.github.io/pipelines-docs/docs/docs/0.7/proc_assembling-a-pipeline.html
[2] https://openshift.github.io/pipelines-docs/docs/docs/0.7/proc_defining-and-creating-pipelineresources.html
[3] https://openshift.github.io/pipelines-docs/docs/docs/0.7/proc_deploying-an-application-to-openshift.html

Describe the Bug
When I create a PipelineResource as a normal user, i receive
pipelineresources.tekton.dev is forbidden: User "demo" cannot create resource "pipelineresources" in API group "tekton.dev" at the cluster scope

Steps to Reproduce

1. OpenShift version 4.2 installed
2. OpenShift Pipelines installed with Operator
3. login with user demo
4. use doc until 3.3

Expected Behavior
I think it should work as normal user.

Additional context
Add any other context about the problem here. If applicable, add screenshots to help explain your problem.

The following changes need to be done:

• The Using Pipelines assembly should be renamed to Creating applications with CI/CD pipelines.
• The first module should be Creating a project instead of Deploying..., delete image attribute, and move step 4 and 5 (first 2 sentences only) to the last module Checking Pipelines...
• Replace Dev console screenshot in Checking Pipelines...to the one in the tutorial. Add a sentence saying for details on using the developer perspective see the dev perspective section with a link.

There are four types of pipeline resources that we support currently, but the docs contain only the examples of two resources (git and image). It would be helpful for developers if the docs contain all the information about the pipeline resources types.
Each type of resources can have a different set of params eg: type git can have url and revision, similarly, can we add all the types and associated params in this doc?

cc: @siamaksade @Preeticp

Is your feature request related to a problem? Please describe.
The current contributing guides do not have instructions on how to update content.
Developers who are unfamiliar with the content generation framework have no clue where to find the current content source and make changes.

Describe the solution you would like to see

1. A single CONTRIBUTING.md file summarizing/linking the existing contributing guides.
2. A separate markdown file describing how the content is organized.
3. A Makefile with commands on how to generate the HTML from the asciidoc content.

I confirmed with the Developers, admin access is required for installing the operator. This information should be mentioned as a prerequisite in the Installation section.
@joaedwar will you be able to take this up?

We need documentation on publishing the docs using Antora with some links etc. in the Contributing guidelines.
@pmacko1 can you please take this task up? You have already provided steps here:

1. install antora
2. fork openshift repo
3. do changes in master
4. preview with $ antora local-site.yml (previews only current branch) so you won't see the versioning -> output file is in build/site/index.html
5. merge to respective branch if your work is finished
6. checkout to master
7. antora --clean --fetch site.yml
8. copy contents of build/site into docs + overwrite
9. post a pr to openshift and cherry pick to respective branches.
10. output is published from master branch to github.io (edited)

Instructions from Joan: To publish latest PRs: 1. install active node, 2. Install antora, 3. Run antora local-site.yml, 4. Run cp -r pipelines-docs/build/site/ pipelines-docs/docs/docs/0.7

I am going to test these today and see if they need to be modified. I will add comments in case we do need changes.

Describe the Bug
A clear and concise description of what the bug is.

Steps to Reproduce
1.
2.
3.

Expected Behavior
A clear and concise description of what you expected to happen.

Additional context
Add any other context about the problem here. If applicable, add screenshots to help explain your problem.

Section 1.2 should have information on Storage resource in addition to the existing ones.
Also check if any other resources should be covered.

There should be space between the command and flags in tkn pipeline logs-f. Correct command is tkn pipeline logs -f:
https://github.com/openshift/pipelines-docs/blob/master/docs/docs/proc_checking-pipeline-and-application-status.html#L120