Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect Formatting of eks-network-add-ons.adoc File #814

Open
antmatts opened this issue Dec 19, 2024 · 1 comment
Open

Incorrect Formatting of eks-network-add-ons.adoc File #814

antmatts opened this issue Dec 19, 2024 · 1 comment
Assignees

Comments

@antmatts
Copy link

Starting at line 2471 in eks-network-add-ons.adoc, the page formatting is broken. What I expect should be a new section with tabs for both Linux and Windows is being indented into the above section of For clusters with Windows nodes only.

Reviewing the content after this line, I can see that there are multiple instances of the formatting characters such as +, **, and ... being displayed as plain characters on the public page, Increase the available IP addresses for your Amazon EKS node.

I don't have a good way of trying to reformat the page myself and display a test page to confirm proper formatting; but this is making this page very difficult to follow. As this page is public, any chance the formatting can be fix quickly or are their any recommend tools to help test/validate formatting changes?

@fincd-aws
Copy link
Contributor

Hi, we used a conversion tool from a syntax-strict internal format to AsciiDoc, which isn't strict and as far as I know, there isn't a syntax-checker/linter for it.

Formatting issues with AsciiDoc "cascade" down a single file, causing other issues. So what I'm doing is splitting eks-network-add-ons.adoc into much smaller files to figure out where the first issue is.

Thanks for the line number, I'll split off cni-increase-ip-addresses-procedure and below and figure out where the first issue is.

In some cases the first issue is "needs two blank lines before a certain formatting declaration" which is hard to spot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants