Skip to content

Commit 96ab406

Browse files
authored
Update README.md
1 parent dd784df commit 96ab406

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,21 @@
22

33
Documentation repository for [eksctl](https://github.com/weaveworks/eksctl), a simple CLI tool for creating and managing clusters on Amazon EKS.
44

5+
The primary documentation is authored in AsciiDoc and automatically published to the official AWS documentation site. Schema references are maintained as static web pages for easy browsing and integration.
6+
7+
## Contribute to the Eksctl User Guide on the AWS Docs
8+
9+
The eksctl docs are now in AsciiDoc, a language very similar to Markdown.
10+
11+
* For information about working with AsciiDoc, see [Contribute to the EKS User Guide](https://docs.aws.amazon.com/eks/latest/userguide/contribute.html)
12+
* All pull requests in this repo need to be reviewed by a AWS Technical Writer.
13+
* [AsciiDoc Syntax Reference](https://docs.aws.amazon.com/eks/latest/userguide/asciidoc-syntax.html)
14+
515
## Repository Structure
616

717
- `docs/` - Main documentation written in AsciiDoc format, published to AWS Documentation
818
- `public-pages/` - Static HTML/JavaScript files containing schema documentation
919

10-
## Documentation
11-
12-
The primary documentation is authored in AsciiDoc and automatically published to the official AWS documentation site. Schema references are maintained as static web pages for easy browsing and integration.
13-
1420
## Contributing
1521

1622
Please refer to the main [eksctl repo](https://github.com/eksctl-io/eksctl) for contribution guidelines and project information.

0 commit comments

Comments
 (0)