Skip to content

Commit 98d1cf8

Browse files
committed
Merge remote-tracking branch 'github/main'
2 parents 2b167b6 + 2379ab4 commit 98d1cf8

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
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.

public-pages/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The purpose of this project is to display a richly formated reference of the eksctl cluster config file schema.
22

3-
View schema: https://geoffcline.github.io/eksctl-schema-demo/
3+
View schema: https://schema.eksctl.io/
44

55
The schema.js file loads the schema json directly from the main github repo.
66

0 commit comments

Comments
 (0)