Skip to content

Commit e30355f

Browse files
mosheshammoshesham
authored
Add sidebar navigation, search, page progress tracking, and project structure improvements (#7)
2 parents 4d906b0 + 9d2932c commit e30355f

File tree

13 files changed

+900
-55
lines changed

13 files changed

+900
-55
lines changed

‎README.md‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,37 @@
77
[![Python](https://img.shields.io/badge/Python-3.8+-3776AB?logo=python)](https://www.python.org/)
88
[![GitHub Actions](https://img.shields.io/badge/CI/CD-GitHub%20Actions-2088FF?logo=github-actions)](https://github.com/features/actions)
99

10+
## 🌐 GitHub Pages
11+
12+
The GitHub Pages for this repository is available at: **[Delta Lake & Apache Iceberg Knowledge Hub](https://analytical-guide.github.io/Datalake-Guide/)**
13+
1014
## 🎯 Vision Statement
1115

1216
**Building the definitive, community-driven knowledge ecosystem for modern data lakehouse technologies.** This repository serves as a living, breathing whitepaper that evolves with the data engineering landscape, combining comprehensive technical comparisons, battle-tested code recipes, and AI-powered content curation to empower data engineers worldwide to make informed architectural decisions and implement best practices for Delta Lake and Apache Iceberg.
1317

18+
## 📁 Repository Content and Structure
19+
20+
This repository is organized into the following sections:
21+
22+
### Core Content
23+
24+
| Section | Location | Description |
25+
|---------|----------|-------------|
26+
| **Feature Matrix** | [`docs/comparisons/feature-matrix.md`](docs/comparisons/feature-matrix.md) | Comprehensive comparison of Delta Lake vs Apache Iceberg |
27+
| **Code Recipes** | [`code-recipes/`](code-recipes/) | Production-ready code examples with validation |
28+
| **Tutorials** | [`docs/tutorials/`](docs/tutorials/) | Step-by-step guides for common use cases |
29+
| **Architecture** | [`docs/architecture/`](docs/architecture/) | Reference architectures and design patterns |
30+
| **Best Practices** | [`docs/best-practices/`](docs/best-practices/) | Industry-tested patterns and recommendations |
31+
32+
### Learning Resources
33+
34+
| Resource | Location | Description |
35+
|----------|----------|-------------|
36+
| **Getting Started** | [`docs/tutorials/getting-started.md`](docs/tutorials/getting-started.md) | Quick start guide for beginners |
37+
| **Migration Guide** | [`docs/tutorials/migration-guide.md`](docs/tutorials/migration-guide.md) | Moving from legacy systems |
38+
| **Knowledge Quiz** | [`quiz/`](quiz/) | Test your Delta Lake & Iceberg knowledge |
39+
| **Design System** | [`docs/design-system.md`](docs/design-system.md) | UI/UX guidelines for the project |
40+
1441
## 📚 Quick Links
1542

1643
- [🔍 **Feature Comparison Matrix**](docs/comparisons/feature-matrix.md) - Detailed side-by-side comparison of Delta Lake vs Apache Iceberg
@@ -72,6 +99,19 @@ Every recipe in our [code-recipes](code-recipes/) directory follows a standardiz
7299
- **Best Practices**: Industry-tested patterns and anti-patterns
73100
- **Architecture Guides**: Reference implementations for various scales
74101

102+
## 🚀 How to Use This Material
103+
104+
1. **Start with the Feature Comparison**: Begin by reading the [Feature Comparison Matrix](docs/comparisons/feature-matrix.md) for a comprehensive overview of Delta Lake vs Apache Iceberg.
105+
106+
2. **Explore the Getting Started Guide**: Use the [Getting Started Tutorial](docs/tutorials/getting-started.md) to set up your first lakehouse.
107+
108+
3. **Review Code Recipes**: Work through the [Code Recipes](code-recipes/) for hands-on implementation examples.
109+
110+
4. **Follow Best Practices**: Study the [Best Practices](docs/best-practices/) for production-ready implementations.
111+
112+
5. **Test Your Knowledge**: Take the [Knowledge Quiz](quiz/) to validate your understanding.
113+
114+
6. **Visit the Website**: Explore the full content at [GitHub Pages](https://analytical-guide.github.io/Datalake-Guide/).
75115

76116
## 🚀 Getting Started
77117

@@ -88,7 +128,7 @@ Every recipe in our [code-recipes](code-recipes/) directory follows a standardiz
88128
3. Review the [Code of Conduct](CODE_OF_CONDUCT.md)
89129
4. Submit your first pull request!
90130

91-
## �️ Development & Deployment
131+
## 🛠️ Development & Deployment
92132

93133
### Prerequisites
94134

@@ -291,7 +331,7 @@ Monitor performance using:
291331
- **WebPageTest**: External performance testing
292332
- **GitHub Actions**: Automated performance checks
293333

294-
## �📈 Repository Stats
334+
## 📈 Repository Stats
295335

296336
![GitHub stars](https://img.shields.io/github/stars/Analytical-Guide/Datalake-Guide?style=social)
297337
![GitHub forks](https://img.shields.io/github/forks/Analytical-Guide/Datalake-Guide?style=social)

‎_config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ github_username: Analytical-Guide
1010
author: "Analytical Guide Community"
1111
email: "[email protected]"
1212

13+
# Analytics (set to your GA4 measurement ID, e.g., G-XXXXXXXXXX)
14+
google_analytics: "G-LHTGZTRTCX"
15+
1316
# Build settings
1417
markdown: kramdown
1518
highlighter: rouge
@@ -30,6 +33,7 @@ include:
3033
- community
3134
- _layouts
3235
- _includes
36+
- _data
3337
- assets
3438

3539
# Exclude files

‎_data/navigation.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
- title: "I. Overview"
2+
url: "/"
3+
icon: "fas fa-home"
4+
children:
5+
- title: "Getting Started"
6+
url: "/docs/tutorials/getting-started/"
7+
- title: "Feature Comparison"
8+
url: "/docs/comparisons/feature-matrix/"
9+
10+
- title: "II. Comparisons"
11+
url: "/docs/comparisons/feature-matrix/"
12+
icon: "fas fa-balance-scale"
13+
children:
14+
- title: "Feature Matrix"
15+
url: "/docs/comparisons/feature-matrix/"
16+
- title: "Time Travel & Versioning"
17+
url: "/docs/comparisons/feature-matrix/#time-travel"
18+
- title: "Schema Evolution"
19+
url: "/docs/comparisons/feature-matrix/#schema-evolution"
20+
21+
- title: "III. Code Recipes"
22+
url: "/code-recipes/"
23+
icon: "fas fa-code"
24+
children:
25+
- title: "Recipe Catalog"
26+
url: "/code-recipes/"
27+
- title: "Basic Delta Table"
28+
url: "/code-recipes/examples/basic-delta-table/"
29+
- title: "Basic Iceberg Table"
30+
url: "/code-recipes/examples/basic-iceberg-table/"
31+
- title: "Streaming CDC Pipeline"
32+
url: "/code-recipes/examples/streaming-cdc-pipeline/"
33+
- title: "Time Series Forecasting"
34+
url: "/code-recipes/examples/time-series-forecasting/"
35+
36+
- title: "IV. Tutorials"
37+
url: "/docs/tutorials/"
38+
icon: "fas fa-graduation-cap"
39+
children:
40+
- title: "Tutorials Hub"
41+
url: "/docs/tutorials/"
42+
- title: "Getting Started"
43+
url: "/docs/tutorials/getting-started/"
44+
- title: "Migration Guide"
45+
url: "/docs/tutorials/migration-guide/"
46+
47+
- title: "V. Architecture"
48+
url: "/docs/architecture/"
49+
icon: "fas fa-cubes"
50+
children:
51+
- title: "Architecture Patterns"
52+
url: "/docs/architecture/"
53+
- title: "System Overview"
54+
url: "/docs/architecture/system-overview/"
55+
- title: "Blueprint"
56+
url: "/docs/BLUEPRINT/"
57+
58+
- title: "VI. Best Practices"
59+
url: "/docs/best-practices/"
60+
icon: "fas fa-check-circle"
61+
children:
62+
- title: "Best Practices Hub"
63+
url: "/docs/best-practices/"
64+
- title: "Production Readiness"
65+
url: "/docs/best-practices/production-readiness/"
66+
67+
- title: "VII. Quiz"
68+
url: "/quiz/"
69+
icon: "fas fa-brain"
70+
71+
- title: "VIII. Community"
72+
url: "/CONTRIBUTING/"
73+
icon: "fas fa-users"
74+
children:
75+
- title: "Contributing"
76+
url: "/CONTRIBUTING/"
77+
- title: "Code of Conduct"
78+
url: "/CODE_OF_CONDUCT/"
79+
- title: "Awesome List"
80+
url: "/docs/awesome-list/"

‎_includes/analytics.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{% if site.google_analytics and site.google_analytics != "" %}
2+
<!-- Google Analytics -->
3+
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
4+
<script>
5+
window.dataLayer = window.dataLayer || [];
6+
function gtag(){dataLayer.push(arguments);}
7+
gtag('js', new Date());
8+
gtag('config', '{{ site.google_analytics }}');
9+
</script>
10+
{% endif %}

‎_includes/sidebar.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<aside class="sidebar" id="sidebar">
2+
<button class="sidebar-toggle" aria-label="Toggle sidebar" aria-expanded="true" id="sidebar-toggle">
3+
<i class="fas fa-chevron-left"></i>
4+
</button>
5+
<h2><i class="fas fa-book"></i> Contents</h2>
6+
<ul class="nav-list">
7+
{% for item in site.data.navigation %}
8+
<li class="nav-item {% if page.url == item.url or page.url contains item.url %}active{% endif %}">
9+
<a href="{{ item.url | relative_url }}" class="nav-link {% if page.url == item.url %}active{% endif %}">
10+
{% if item.icon %}<i class="{{ item.icon }}"></i>{% endif %} {{ item.title }}
11+
</a>
12+
{% if item.children %}
13+
<ul class="nav-children">
14+
{% for child in item.children %}
15+
<li>
16+
<a href="{{ child.url | relative_url }}" class="{% if page.url == child.url %}active{% endif %}">
17+
{{ child.title }}
18+
</a>
19+
</li>
20+
{% endfor %}
21+
</ul>
22+
{% endif %}
23+
</li>
24+
{% endfor %}
25+
</ul>
26+
</aside>

0 commit comments

Comments
 (0)