Skip to content

Commit 4d62013

Browse files
authored
Update README.md
1 parent e2e91f4 commit 4d62013

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1+
# eksctl-docs
12

2-
## Amazon EKS -- Eksctl Docs
3+
Documentation repository for [eksctl](https://github.com/weaveworks/eksctl), a simple CLI tool for creating and managing clusters on Amazon EKS.
34

4-
Guide Package for Amazon EKS -- Eksctl
5+
## Repository Structure
56

6-
Initial guide pathslug when package created: /eks/latest/userguide
7+
- `docs/` - Main documentation written in AsciiDoc format, published to AWS Documentation
8+
- `public-pages/` - Static HTML/JavaScript files containing schema documentation
79

10+
## Documentation
811

9-
## Security
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.
1013

11-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
12-
13-
## License
14-
15-
This project is licensed under the Apache-2.0 License.
14+
## Contributing
1615

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

0 commit comments

Comments
 (0)