Skip to content

Code snippet tweaks#3792

Merged
knative-prow-robot merged 5 commits into
knative:mkdocsfrom
snneji:code-snippet-tweaks
Jun 16, 2021
Merged

Code snippet tweaks#3792
knative-prow-robot merged 5 commits into
knative:mkdocsfrom
snneji:code-snippet-tweaks

Conversation

@snneji
Copy link
Copy Markdown
Contributor

@snneji snneji commented Jun 14, 2021 •
edited
Loading

Fixes #3791

  • Added context to code snippets on reference page
  • Adjusted indentation in code snippet in Create a SinkBinding object section

Other tweaks

  • Made the topic title a gerund
  • Adjusted the app name in the kn command for creating a Knative Service to match the YAML
  • Fixed the note at the end of the reference topic
  • Removed API label from Creating a SinkBinding page because it is already on the README page

@google-cla google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label Jun 14, 2021
@knative-prow-robot knative-prow-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 14, 2021
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 14, 2021 •
edited
Loading

✔️ Deploy Preview for dev-knative ready!

🔨 Explore the source changes: 14ebf8d

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

😎 Browse the preview: https://deploy-preview-3792--dev-knative.netlify.app/development/eventing/sources/sinkbinding/reference

abrennan89
abrennan89 reviewed Jun 14, 2021
View reviewed changes
Comment thread docs/eventing/sources/sinkbinding/getting-started.md
abrennan89
abrennan89 suggested changes Jun 14, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@abrennan89 abrennan89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making these updates @snneji - just one thing I think that shouldn't be deleted, then I can approve/merge

@snneji snneji requested a review from abrennan89 June 16, 2021 13:24
abrennan89
abrennan89 approved these changes Jun 16, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@abrennan89 abrennan89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Thanks @snneji ! 🙂

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 16, 2021
@knative-prow-robot
Copy link
Copy Markdown
Contributor

knative-prow-robot commented Jun 16, 2021

[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:

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

@knative-prow-robot knative-prow-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 16, 2021
@knative-prow-robot knative-prow-robot merged commit 724ffe8 into knative:mkdocs Jun 16, 2021
RichardJJG pushed a commit to RichardJJG/docs that referenced this pull request Jul 1, 2021
@snneji @RichardJJG
Code snippet tweaks (knative#3792)
9556d0d 
* Add context to code snippets

* A few other tweaks

* Remove duplicate API label

* Add back API label

* Add API version label
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@abrennan89 abrennan89 abrennan89 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@abrennan89 abrennan89

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve code snippets in SinkBinding reference

3 participants

@snneji @knative-prow-robot @abrennan89