SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure #33595

abrennan89 · 2021-06-17T17:52:49Z

Applies for OCP 4.6+

This PR covers some updates to the serverless documentation structure as per https://issues.redhat.com/browse/SRVCOM-1245, as well as creation of a central place in docs under Knative Eventing to cover event sinks, as per the comments in https://issues.redhat.com/browse/SRVCLI-296

Direct preview links:

Understanding Knative Serving: https://deploy-preview-33595--osdocs.netlify.app/openshift-enterprise/latest/serverless/knative_serving/serverless-understanding-serving.html
Understanding Knative Eventing: https://deploy-preview-33595--osdocs.netlify.app/openshift-enterprise/latest/serverless/knative_eventing/serverless-understanding-eventing.html
Event sinks: https://deploy-preview-33595--osdocs.netlify.app/openshift-enterprise/latest/serverless/knative_eventing/serverless-event-sinks.html
CLI tools section: https://deploy-preview-33595--osdocs.netlify.app/openshift-enterprise/latest/serverless/cli_tools/installing-kn.html
Tracing (moved): https://deploy-preview-33595--osdocs.netlify.app/openshift-enterprise/latest/serverless/knative_serving/serverless-tracing.html
High availability (moved): https://deploy-preview-33595--osdocs.netlify.app/openshift-enterprise/latest/serverless/admin_guide/serverless-ha.html

netlify · 2021-06-17T17:58:14Z

✔️ Deploy Preview for osdocs ready!

🔨 Explore the source changes: df9bc7f

🔍 Inspect the deploy log: https://app.netlify.com/sites/osdocs/deploys/60d4c87a8844970007874643

😎 Browse the preview: https://deploy-preview-33595--osdocs.netlify.app

_topic_map.yml

jrangelramos · 2021-06-22T17:08:18Z

LGTM
QE Approved

modules/serverless-jaeger-config.adoc

serverless/knative_eventing/serverless-event-sinks.adoc

serverless/knative_eventing/serverless-understanding-eventing.adoc

_topic_map.yml

serverless/serverless-getting-started.adoc

mburke5678 · 2021-06-23T01:23:26Z

@abrennan89 A few nits, a few questions. Otherwise looks good to me!

mburke5678 · 2021-06-24T17:54:08Z

@abrennan89 The changes LGTM

…ucture

abrennan89 · 2021-06-24T18:05:24Z

/cherrypick enterprise-4.6

abrennan89 · 2021-06-24T18:05:30Z

/cherrypick enterprise-4.7

abrennan89 · 2021-06-24T18:05:35Z

/cherrypick enterprise-4.8

openshift-cherrypick-robot · 2021-06-24T18:06:00Z

@abrennan89: #33595 failed to apply on top of branch "enterprise-4.6":

Applying: SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure
Using index info to reconstruct a base tree...
M	_topic_map.yml
M	modules/serverless-config-replicas.adoc
A	modules/serverless-connect-sink-source-odc.adoc
M	modules/serverless-jaeger-config.adoc
M	security/container_security/security-build.adoc
M	serverless/channels/connect-channels-event-source.adoc
M	serverless/event_sources/srvls-connecting-source-sinks.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): serverless/event_sources/srvls-connecting-source-sinks.adoc deleted in SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure and modified in HEAD. Version HEAD of serverless/event_sources/srvls-connecting-source-sinks.adoc left in tree.
CONFLICT (content): Merge conflict in serverless/cli_tools/modules
CONFLICT (content): Merge conflict in serverless/cli_tools/images
Removing serverless/cli_reference/modules
Removing serverless/cli_reference/images
CONFLICT (modify/delete): serverless/channels/connect-channels-event-source.adoc deleted in SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure and modified in HEAD. Version HEAD of serverless/channels/connect-channels-event-source.adoc left in tree.
Removing serverless/architecture/serverless-event-architecture.adoc
Auto-merging security/container_security/security-build.adoc
CONFLICT (content): Merge conflict in security/container_security/security-build.adoc
Auto-merging modules/serverless-jaeger-config.adoc
CONFLICT (content): Merge conflict in modules/serverless-jaeger-config.adoc
CONFLICT (modify/delete): modules/serverless-connect-sink-source-odc.adoc deleted in HEAD and modified in SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure. Version SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure of modules/serverless-connect-sink-source-odc.adoc left in tree.
Auto-merging modules/serverless-config-replicas.adoc
CONFLICT (content): Merge conflict in modules/serverless-config-replicas.adoc
Auto-merging _topic_map.yml
CONFLICT (content): Merge conflict in _topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherrypick enterprise-4.6

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.

openshift-cherrypick-robot · 2021-06-24T18:06:06Z

@abrennan89: #33595 failed to apply on top of branch "enterprise-4.7":

Applying: SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure
Using index info to reconstruct a base tree...
M	_topic_map.yml
A	modules/serverless-connect-sink-source-odc.adoc
M	serverless/channels/connect-channels-event-source.adoc
M	serverless/event_sources/srvls-connecting-source-sinks.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): serverless/event_sources/srvls-connecting-source-sinks.adoc deleted in SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure and modified in HEAD. Version HEAD of serverless/event_sources/srvls-connecting-source-sinks.adoc left in tree.
CONFLICT (content): Merge conflict in serverless/cli_tools/modules
CONFLICT (content): Merge conflict in serverless/cli_tools/images
Removing serverless/cli_reference/modules
Removing serverless/cli_reference/images
CONFLICT (modify/delete): serverless/channels/connect-channels-event-source.adoc deleted in SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure and modified in HEAD. Version HEAD of serverless/channels/connect-channels-event-source.adoc left in tree.
Removing serverless/architecture/serverless-event-architecture.adoc
CONFLICT (modify/delete): modules/serverless-connect-sink-source-odc.adoc deleted in HEAD and modified in SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure. Version SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure of modules/serverless-connect-sink-source-odc.adoc left in tree.
Auto-merging _topic_map.yml
CONFLICT (content): Merge conflict in _topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherrypick enterprise-4.7

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.

openshift-cherrypick-robot · 2021-06-24T18:06:11Z

@abrennan89: #33595 failed to apply on top of branch "enterprise-4.8":

Applying: SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure
Using index info to reconstruct a base tree...
M	_topic_map.yml
M	serverless/architecture/serverless-event-architecture.adoc
M	serverless/event_sources/knative-event-sources.adoc
A	serverless/knative_eventing/serverless-triggers.adoc
Falling back to patching base and 3-way merge...
Removing serverless/event_sources/srvls-connecting-source-sinks.adoc
Auto-merging serverless/event_sources/knative-event-sources.adoc
CONFLICT (content): Merge conflict in serverless/cli_tools/modules
CONFLICT (content): Merge conflict in serverless/cli_tools/images
Removing serverless/cli_reference/modules
Removing serverless/cli_reference/images
Removing serverless/channels/connect-channels-event-source.adoc
CONFLICT (modify/delete): serverless/architecture/serverless-event-architecture.adoc deleted in SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure and modified in HEAD. Version HEAD of serverless/architecture/serverless-event-architecture.adoc left in tree.
Auto-merging _topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherrypick enterprise-4.8

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.

abrennan89 added branch/enterprise-4.6 serverless Label for all Serverless PRs branch/enterprise-4.7 branch/enterprise-4.8 labels Jun 17, 2021

abrennan89 added this to the Next Release milestone Jun 17, 2021

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 17, 2021

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 17, 2021

abrennan89 force-pushed the sinkdocs branch 4 times, most recently from 2c52c2f to f3a3286 Compare June 18, 2021 15:18

openshift-ci bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 19, 2021

abrennan89 force-pushed the sinkdocs branch from f3a3286 to 56cbbaa Compare June 21, 2021 13:52

dsimansk reviewed Jun 22, 2021

View reviewed changes

_topic_map.yml Outdated Show resolved Hide resolved

openshift-ci bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 22, 2021

abrennan89 changed the title ~~[WIP] SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure~~ SRVCLI-296 + SRVCOM-1245: Updating serving, eventing and sink doc structure Jun 22, 2021

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 22, 2021