documentation added for pipelines

[enekofb]

Closes weaveworks/weave-gitops-enterprise#1274

What changed?
Added documentation for pipelines

Why was this change made?

In order to document the released feature

How was this change implemented?

Adding documentation. It is place under the enterprise section, differently to other enterprise features in the main documentation root. the motivation is that seems to be a more clear navigation for users.

How did you validate the change?

Locally

Release notes

• No

Documentation Changes

• It is a documentation change itself

[yiannistri]

Looks good to me 👍 I'm not sure we need to show details of the Go types of the pipeline and keep that reference always current going forward if we don't provide a way to interact with it programmatically. But I can be convinced otherwise.

[yiannistri]

Not sure why perf needs to be wrapped in round brackets.

[enekofb]

remove the wrapping

[enekofb]

Looks good to me 👍 I'm not sure we need to show details of the Go types of the pipeline and keep that reference always current going forward if we don't provide a way to interact with it programmatically. But I can be convinced otherwise.

@yiannistri

do you mean?

https://github.com/weaveworks/weave-gitops/pull/2793/files#diff-e5b3bdfc3a2cfcc6447284d76b58139d8df76bb32b72786e018f8e82cb9ef3fcR56

it just mimics flux documentation https://github.com/fluxcd/helm-controller/blob/main/docs/spec/v2beta1/helmreleases.md

mentioned in the standup, not sure whether this is the approach that we want to follow so feel free to share preference / alternative

[sympatheticmoose]

Thank you @enekofb for taking the time to write these docs. They're good - my comments are mostly nits.

On reflection, I am wondering about the nesting under enterprise and some placement of the docs. However, we are about to revisit the overall structure and more changes may occur. In terms of expedience, please feel free to merge in their current form, and we can use some of the comments I've made in this PR when reworking the site structure.

[yiannistri]

do you mean?

https://github.com/weaveworks/weave-gitops/pull/2793/files#diff-e5b3bdfc3a2cfcc6447284d76b58139d8df76bb32b72786e018f8e82cb9ef3fcR56

it just mimics flux documentation https://github.com/fluxcd/helm-controller/blob/main/docs/spec/v2beta1/helmreleases.md

mentioned in the standup, not sure whether this is the approach that we want to follow so feel free to share preference / alternative

Yes I was referring to those. I think they're useful in general but I would suggest postpone adding them because a) we're still making changes to the CRD for promotions and b) the current spec is not as sophisticated as the Flux primitives to justify adding them to docs.

Other than that, the docs look good so I'll defer to your judgement regarding this.

[enekofb]

do you mean?
https://github.com/weaveworks/weave-gitops/pull/2793/files#diff-e5b3bdfc3a2cfcc6447284d76b58139d8df76bb32b72786e018f8e82cb9ef3fcR56
it just mimics flux documentation https://github.com/fluxcd/helm-controller/blob/main/docs/spec/v2beta1/helmreleases.md
mentioned in the standup, not sure whether this is the approach that we want to follow so feel free to share preference / alternative

Yes I was referring to those. I think they're useful in general but I would suggest postpone adding them because a) we're still making changes to the CRD for promotions and b) the current spec is not as sophisticated as the Flux primitives to justify adding them to docs.

Other than that, the docs look good so I'll defer to your judgement regarding this.

@yiannistri sounds good, i could remove it however there is gap that I could think we need to cover which is

as user without pipelines knowledge, i want to have some documentation to write a pipeline

for example to understand the different namespaces or so

https://github.com/weaveworks/weave-gitops/pull/2793/files#diff-e5b3bdfc3a2cfcc6447284d76b58139d8df76bb32b72786e018f8e82cb9ef3fcR90-R93

this is part of the CRD / generated go types.

How should we capture this?

[yiannistri]

Fair enough 👍 Let's get this in.