File tree Expand file tree Collapse file tree 2 files changed +41
-6
lines changed Expand file tree Collapse file tree 2 files changed +41
-6
lines changed Original file line number Diff line number Diff line change @@ -24,7 +24,7 @@ SPDX-License-Identifier: CC-BY-4.0
2424[ ![ Helm] ( https://img.shields.io/badge/Helm-0F1689?style=flat&logo=helm&logoColor=white )] ( https://helm.sh/ )
2525[ ![ REUSE Compliance] ( https://img.shields.io/badge/REUSE-compliant-green )] ( https://reuse.software/ )
2626
27- [ ![ GitHub Issues] ( https://img.shields.io/github/issues/InditexTech/k8s-overcommit-operator )]
27+ [ ![ GitHub Issues] ( https://img.shields.io/github/issues/InditexTech/k8s-overcommit-operator )] ( https://github.com/InditexTech/k8s-overcommit-operator/issues )
2828[ ![ GitHub Pull Requests] ( https://img.shields.io/github/issues-pr/InditexTech/k8s-overcommit-operator )] ( https://github.com/InditexTech/k8s-overcommit-operator/pulls )
2929[ ![ GitHub Stars] ( https://img.shields.io/github/stars/InditexTech/k8s-overcommit-operator?style=social )] ( https://github.com/InditexTech/k8s-overcommit-operator/stargazers )
3030[ ![ GitHub Forks] ( https://img.shields.io/github/forks/InditexTech/k8s-overcommit-operator?style=social )] ( https://github.com/InditexTech/k8s-overcommit-operator/network/members )
Original file line number Diff line number Diff line change @@ -5,12 +5,47 @@ SPDX-FileContributor: enriqueavi@inditex.com
55SPDX-License-Identifier: CC-BY-4.0
66-->
77
8- # Documentation
8+ # 📚 Documentation
99
10- [ Arquitecture ] ( ./architecture.md )
10+ ---
1111
12- [ Quickstart ] ( ./quickstart.md )
12+ ## �️ Available Documentation
1313
14- [ Metrics] ( ./metrics.md )
14+ | 📄 Document | 📝 Description |
15+ | -------------| -----------------|
16+ | 🏗️ ** [ Architecture] ( ./architecture.md ) ** | Learn about the system design and components |
17+ | 🚀 ** [ Quickstart] ( ./quickstart.md ) ** | Get up and running quickly with step-by-step guide |
18+ | 📊 ** [ Metrics] ( ./metrics.md ) ** | Monitor and observe your operator |
19+ | 🧪 ** [ E2E Tests] ( ./e2e-test.md ) ** | End-to-end testing guide and best practices |
1520
16- [ E2E Tests] ( ./e2e-test.md )
21+ ---
22+
23+ ## 🔗 Quick Navigation
24+
25+ ### 🏗️ Architecture
26+
27+ Understand the system design, components, and how everything fits together.
28+
29+ 👉 ** [ Read Architecture Guide] ( ./architecture.md ) **
30+
31+ ### 🚀 Quickstart
32+
33+ Get started in minutes with our comprehensive step-by-step guide.
34+
35+ 👉 ** [ Start Here] ( ./quickstart.md ) **
36+
37+ ### 📊 Metrics
38+
39+ Monitor your operator with comprehensive metrics and observability.
40+
41+ 👉 ** [ View Metrics Guide] ( ./metrics.md ) **
42+
43+ ### 🧪 E2E Tests
44+
45+ Learn how to run and write effective end-to-end tests.
46+
47+ 👉 ** [ Testing Guide] ( ./e2e-test.md ) **
48+
49+ ---
50+
51+ 📖 Happy documenting! 🎉
You can’t perform that action at this time.
0 commit comments