Relocate event source docs by snneji · Pull Request #3948 · knative/docs

snneji · 2021-07-06T14:01:39Z

Fixes #3936

Moved files to the developer directory
Updated nav.yaml
Updated links

netlify · 2021-07-06T14:05:27Z

✔️ Deploy Preview for dev-knative ready!

🔨 Explore the source changes: 2a83ded

🔍 Inspect the deploy log: https://app.netlify.com/sites/dev-knative/deploys/60e5b57c255c74000846c994

😎 Browse the preview: https://deploy-preview-3948--dev-knative.netlify.app

snneji · 2021-07-06T15:13:05Z

/retest

abrennan89 · 2021-07-06T20:28:08Z

+          - Creating an event source:
+            - Overview: developer/eventing/sources/creating-event-sources/README.md
+            - Writing an event source using Javascript: developer/eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md
+            - Using the sample event source:
+              - Overview: developer/eventing/sources/creating-event-sources/writing-event-source/README.md
+              - Design of an Event Source: developer/eventing/sources/creating-event-sources/writing-event-source/01-theory.md
+              - Lifecycle and Types: developer/eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md
+              - Controller Implemetation: developer/eventing/sources/creating-event-sources/writing-event-source/03-controller.md
+              - Reconciler Implementation: developer/eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md
+              - Receive Adapter Implementation: developer/eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md
+              - Publishing to your cluster: developer/eventing/sources/creating-event-sources/writing-event-source/06-yaml.md
+              - Moving to knative-sandbox: developer/eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md


I would put this under Event Sources to keep all the event sources docs grouped?

abrennan89 · 2021-07-06T20:30:14Z

+        - CloudAuditLogsSource: eventing/samples/cloud-audit-logs-source/README.md
+        - CloudPubSubSource: eventing/samples/cloud-pubsub-source/README.md
+        - CloudSchedulerSource: eventing/samples/cloud-scheduler-source/README.md
+        - CloudStorageSource: eventing/samples/cloud-storage-source/README.md
+        - GitHub source: eventing/samples/github-source/README.md
+        - GitLab source: eventing/samples/gitlab-source/README.md


Same for all of these, idk why they wouldn't be part of the single Event Source docs section?

I was confused about what to do with samples. There were three options I could think of (I was not sure which one we plan to do so I just left them where they were):

Do we plan to have a section of the docs for all samples?

Or a subsection for all samples at the end of each guide?

Or do we want to have samples at the end of each subgroup -- eg, event source samples, autoscaling samples?

I think if we have all the samples in the same place it might be easier to link to from the What's Next page, but this is not a strongly held position.

Will deal with samples in #3796

I would prefer we don't have a samples section at all and just add them as part of the main docs for each thing they're a sample of. As a user I wouldn't want to look in two different places for docs on how to create a resource and then samples for them. For example, rather than having a GitLab source sample somewhere, just add GitLab source to the main event source docs and use the sample as a basis for documenting it properly.

abrennan89 · 2021-07-06T20:38:01Z

/approve
/lgtm

Found one seemingly broken link and left some suggestions, but otherwise looks good.
Feel free to remove the hold if you want to merge this @snneji

/hold

knative-prow-robot · 2021-07-06T20:38:07Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, snneji

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [abrennan89]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

omerbensaadon · 2021-07-07T13:57:37Z

/lgtm

omerbensaadon · 2021-07-07T13:57:44Z

/unhold

omerbensaadon · 2021-07-07T13:58:15Z

/hold

snneji · 2021-07-07T14:00:17Z

/unhold

omerbensaadon · 2021-07-07T14:00:23Z

/unhold

omerbensaadon · 2021-07-07T14:02:42Z

/hold

omerbensaadon · 2021-07-07T14:09:55Z

/lgtm

omerbensaadon · 2021-07-07T14:10:00Z

/unhold

* Update links * Update nav.yaml for event source move * fix another link * Move event source files to developer guide * Move event samples to samples folder * Move event samples to samples folder * link fixes and improvements * tweak some more links * Update redirects * Rebase redirects * fixing infinite redirect bug * Move creating event sources Co-authored-by: Omer B <obensaadon@vmware.com>

snneji added 8 commits July 5, 2021 19:18

Update links

5163852

Update nav.yaml for event source move

f24bee4

fix another link

205ceb8

Move event source files to developer guide

2ce64c8

Move event samples to samples folder

63c783e

Move event samples to samples folder

343fc62

link fixes and improvements

8dc6d4b

tweak some more links

7bc943c

knative-prow-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 6, 2021

google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label Jul 6, 2021

snneji marked this pull request as draft July 6, 2021 14:11

knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 6, 2021

snneji changed the title ~~Relocate event source docs~~ (WIP) Relocate event source docs Jul 6, 2021

Update redirects

6b2feae

knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 6, 2021

snneji added 2 commits July 6, 2021 16:20

Rebase redirects

ba3b387

Merge branch 'mkdocs' into relocate-event-source-docs

1bc9478

knative-prow-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 6, 2021

snneji marked this pull request as ready for review July 6, 2021 15:27

snneji changed the title ~~(WIP) Relocate event source docs~~ Relocate event source docs Jul 6, 2021

knative-prow-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 6, 2021

abrennan89 reviewed Jul 6, 2021

View reviewed changes

Comment thread config/nav.yml

abrennan89 reviewed Jul 6, 2021

View reviewed changes

Comment thread docs/admin/install/eventing/install-eventing-with-yaml.md

knative-prow-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 6, 2021

knative-prow-robot assigned abrennan89 Jul 6, 2021

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 6, 2021

knative-prow-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 6, 2021

fixing infinite redirect bug

605a30f

knative-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2021

knative-prow-robot assigned omerbensaadon Jul 7, 2021

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2021

knative-prow-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 7, 2021

knative-prow-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 7, 2021

knative-prow-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 7, 2021

knative-prow-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 7, 2021

Move creating event sources

2a83ded

knative-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2021

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2021

knative-prow-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 7, 2021

knative-prow-robot merged commit 0695377 into knative:mkdocs Jul 7, 2021

Conversation

snneji commented Jul 6, 2021

Uh oh!

netlify Bot commented Jul 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snneji commented Jul 6, 2021

Uh oh!

abrennan89 Jul 6, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abrennan89 Jul 6, 2021

Choose a reason for hiding this comment

Uh oh!

snneji Jul 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abrennan89 Jul 7, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abrennan89 commented Jul 6, 2021

Uh oh!

knative-prow-robot commented Jul 6, 2021

Uh oh!

omerbensaadon commented Jul 7, 2021

Uh oh!

omerbensaadon commented Jul 7, 2021

Uh oh!

omerbensaadon commented Jul 7, 2021

Uh oh!

snneji commented Jul 7, 2021

Uh oh!

omerbensaadon commented Jul 7, 2021

Uh oh!

omerbensaadon commented Jul 7, 2021

Uh oh!

omerbensaadon commented Jul 7, 2021

Uh oh!

omerbensaadon commented Jul 7, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify Bot commented Jul 6, 2021 •

edited

Loading

snneji Jul 7, 2021 •

edited

Loading