aws / aws/aws-cdk

aws-eks-v2: Architecture Diagram Broken

Open Beginner friendly
#38,336 1 comment 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-eks-v2 documentation effort/small p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the issue

Was looking at implementing docs for the Ruby language bindings and noticed the architecture diagram is a little broken.

cmark renders it in the least broken way (Github's native)

Image

redcarpet renders differently, however, this was after mangling the input, without the mangling the text fence broke the rest of the documentation

Image

Realistically, this should have a documentation fix:

Image

Note that the text fence is on the same line as the top of the box and this is why it is breaking

### Links

https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-eks-v2
https://rubygems.omarqureshi.net/docs/AWSCDK/EKSv2/index.html

Contributor guide

Open the contributing guide

Research direction

Start in packages/aws-cdk-lib/aws-eks-v2 and inspect the documentation source for the architecture diagram, paying attention to the text fence at the top of the box. Compare the rendered result with the linked Ruby AWSCDK/EKSv2 documentation; done means the diagram and the surrounding documentation render correctly without input mangling.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.