chore (docs): Updated ECS readme to use branded AWS/Amazon service names #1703
Conversation
packages/@aws-cdk/aws-ecs/README.md
Outdated
| @@ -1,7 +1,18 @@ | |||
| ## AWS Elastic Container Service (ECS) Construct Library | |||
| ## Amazon Elastic Container Service (Amazon ECS) Construct Library | |||
There was a problem hiding this comment.
@Doug-AWS we had a chat today about this and decided that we will change all the README files to H1s instead of H2s and use the short name as the H1 heading (#501).
So the title here should be simply:
# Amazon ECS
copy: @RomainMuller @rix0rrr
There was a problem hiding this comment.
Great, I wasn't a fan of the long titles anyway. When I drop it into the docs, I'll probably append "Examples" to the H1 heading ("Amazon ECS" -> "Amazon ECS Examples".
There was a problem hiding this comment.
Let's discuss this idea of "dropping the READMEs into the docs". I don't think it's a sustainable approach. These README files are constantly changing
There was a problem hiding this comment.
Sure, but keep in mind I use a script. Whenever we release, I run the script and snarf the content of the L2 README.md files in "Developer Preview" status into the guide's Examples section. It takes me all of about 5 minutes. The biggest effort is editing the L2 README.md file once the status is "Developer Preview". That's a much longer process.
There was a problem hiding this comment.
But those are not examples, so why would we put them there?
There was a problem hiding this comment.
How about in an "About the AWS Construct Libraries" section? I can easily change my script.
Doug-AWS
changed the title
If we make the top-level heading an H1, we have to promote the sub-headings (done).
|
@SoManyHs can you please take a look? |
Pull Request Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.