Updating Target Docs to Match Template #135

alicenstar · 2021-04-21T00:46:19Z

Changes

Updated all current Target doc pages to more closely follow the template. Edited capitalization, spelling, and grammatical errors as well as tried to smooth the wording of a few sections, and formatted all pages to be more uniform.

Checklist

Go to templates/target/targetExample.md change Prerequisites to Prerequisite(s)
Go to templates/target/targetTemplate.md change Prerequisites to Prerequisite(s)
Go through all of the targets in the folder targets and change the format to the template

Related issue(s)

Addresses issue #129

daceynolan

Thank you so much for your hard work on this and for taking the initiative to look for grammar and spelling mistakes. I did have a few nitpicky changes. Some of the changes I tried to point out all of the instances, I might have missed some. Please let me know if you have questions or concerns. :)

Some of these are things I just learned pertaining to numbering info and adding bullet points. Please just check to make sure I didn't miss any. Any time we use number lists, we would like it to use all 1. because this will auto-format to correct numbers, and if anything changes in the future the next devs will not need to re number.

Also, any - unordered list should be changed to. *. The do the same in markdown, but we think more files had *

daceynolan · 2021-04-21T13:15:12Z

docs/targets/awskinesis.md


-1. AWS API key and secret
+- AWS API key and secret


Sorry I just learned this but we can use * here instead of -. Do you mind changing this? Do you also mind changing the template and the example?

To be fair, the only reason why I asked not to use - in the previous PR is that we were using * everywhere else, and I didn't want the PR to drift into that discussion and become larger than it should be.

With that being said, I do agree that - would be the more logical choice, since it eliminates the ambiguity between * (bulltet point), * * (italic) and ** ** (bold) <-- I blame markdown for this mess.

I think we should replace * with - in all our lists, but we should do it in one pass, as a separate PR.

WDYT?

I think I agree with Antoine in that using - may be easier to differentiate from italic and bold notation. I can make the changes unless there are any strong feelings otherwise.

But I will make the numerical changes and be sure to standardize the notation for unordered lists. :)

@antoineco I like using - better *

@thomasgilmore95 is making a rules guideline. Thomas, do you mind adding that all unordered list should use - instead?

@antoineco @daceynolan I will make the unordered list to - instead.

@thomasgilmore95 I actually went ahead and changed it already in this PR if that's alright. It'll show up in my next commit.

@alicenstar sounds good.

@thomasgilmore95 I think @alicenstar only changed the targets so it is okay if you work on the sources you worked on yesterday :)

daceynolan · 2021-04-21T13:17:08Z

docs/targets/awskinesis.md


 ![AWS Kinesis Target form](../images/aws-targets/aws-kinesis-bridge-create-2.png)

 After clicking the `Save` button, the console will self-navigate to the Bridge editor. Proceed by adding the remaining components to the Bridge.

 ![Bridge overview](../images/aws-targets/aws-kinesis-bridge-create-3.png)

-After submitting the bridge, and allowing some configuration time, a green check mark on the main _Bridges_ page indicates that the bridge with the AWS Kinesis Target was successfully created.
+After submitting the Bridge, and allowing for some configuration time, a green check mark on the main _Bridges_ page indicates that the Bridge with the AWS Kinesis Target was successfully created.


@odacremolbap and @antoineco I like how @alicenstar added a capital letter for Bridge. I assume this was to stand out to the user. Maybe we could highlight them. What do you all think?

I'm also +1 on that.

Agree, since "bridge" is a common word, the capital letter makes it stand out as "TriggerMesh Bridge" and not just a bridge in the common meaning. I like it.

Awesome. In the rules guide @thomasgilmore95 is making, Thomas is also going to add this in the rules.

Glad you guys liked that - I figured it would be helpful since your docs already highlight other pertinent words such as Target.

daceynolan · 2021-04-21T13:17:40Z

docs/targets/awslambda.md


-1. AWS API key and secret
+- AWS API key and secret


These can be turned to *

If we agree that we will use - in the future and address lists which are already unordered in a separate PR, I think those changes can stay.

I'm not feeling strongly about it, just want to avoid discouraging people for something we may replace anyway 🙂

If we decide not to use -, then it's a different story of course.

The consensus is to use -

daceynolan · 2021-04-21T13:18:39Z

docs/targets/awss3.md


-1. ARN for the S3 bucket to store the event
+- ARN for the S3 bucket to store the event


this could be *

Alicen, please ignore these comments.

docs/targets/awssqs.md

daceynolan · 2021-04-21T13:38:04Z

docs/targets/tekton.md


-A Tekton Task must exist prior to creating the Target.
+- A Tekton Task must exist prior to creating the Target


I would just write Tekton Task

daceynolan · 2021-04-21T13:39:08Z

docs/targets/splunk.md


 1. Enable the [HTTP Event Collector][hec] data input in the Splunk installation.
-1. Create a token for receiving data over HTTP.
+2. Create a token for receiving data over HTTP.


I just learned this yesterday. If we number lists all as 1. like this previously was, it will auto number.

docs/targets/splunk.md

docs/targets/slack.md

antoineco

Thanks a lot for this! 🙌

daceynolan

Awesome work! Thank you so much for doing this. @odacremolbap do you have anything else?

* docs: Edit target template and example * docs: Update and format existings files * docs: Update and format existings files * docs: Update and format existing files * docs: Update and format existing files

daceynolan requested review from odacremolbap, antoineco and daceynolan April 21, 2021 13:13

daceynolan suggested changes Apr 21, 2021

View reviewed changes

antoineco approved these changes Apr 21, 2021

View reviewed changes

daceynolan approved these changes Apr 21, 2021

View reviewed changes

alicenstar added 4 commits April 21, 2021 15:02

docs: Edit target template and example

6506024

docs: Update and format existings files

6dd3ff5

docs: Update and format existings files

0ec07f1

docs: Update and format existing files

e599f1d

alicenstar force-pushed the docsedits branch from 03e5d08 to e599f1d Compare April 21, 2021 20:06

docs: Update and format existing files

92f8db4

daceynolan merged commit 5ac2a1c into triggermesh:master Apr 21, 2021


		1. ARN for the S3 bucket to store the event
		- ARN for the S3 bucket to store the event


		A Tekton Task must exist prior to creating the Target.
		- A Tekton Task must exist prior to creating the Target

Updating Target Docs to Match Template #135

Updating Target Docs to Match Template #135

Uh oh!

Conversation

alicenstar commented Apr 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Checklist

Related issue(s)

Uh oh!

daceynolan left a comment • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

antoineco Apr 21, 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!

daceynolan Apr 21, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

antoineco Apr 21, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

antoineco left a comment

Choose a reason for hiding this comment

Uh oh!

daceynolan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alicenstar commented Apr 21, 2021 •

edited

Loading

daceynolan left a comment •

edited

Loading

antoineco Apr 21, 2021 •

edited

Loading

daceynolan Apr 21, 2021 •

edited

Loading

antoineco Apr 21, 2021 •

edited

Loading