chore (docs): Made sure CodeBuild and CodeCommit always have the AWS prefix #1707
Conversation
Doug-AWS
requested review from
RomainMuller,
skinny85 and
a team
as code owners
| @@ -222,7 +222,7 @@ new codebuild.PipelineTestAction(this, 'IntegrationTest', { | |||
| stage: buildStage, | |||
| project, | |||
| // outputArtifactName is optional - if you don't specify it, | |||
| // the Action will have an undefined `outputArtifact` property | |||
| // the Action has an undefined `outputArtifact` property | |||
There was a problem hiding this comment.
I would keep the future tense here (this comment is on a construction property, when the object does not exist yet, so using the present tense feels weird here).
There was a problem hiding this comment.
Good point. I'll revert the change.
There was a problem hiding this comment.
We do NOT have to spell out "AWS CodeBuild" on every usage. I have a source that confirms we use "AWS CodeBuild" on the first usage on the page, and afterwards we use the shorter name "CodeBuild". Especially in the README it becomes cumbersome to read.
In fact, I think our README was already compliant since it had "AWS CodeBuild" in the header (though it might be a matter of debate whether it needs to be in running text or not)
I have a link to an authoritative doc if you need proof of this.
Removed tedious AWS prefix after first reference.
|
I kept one extra "AWS" after the top-level heading. |
Pull Request Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.