Docs: Add demo video - Contributors section - Discord link #172
Conversation
WalkthroughThe updates introduce a new contributors page with a dynamic GitHub contributors grid, modify the homepage to promote Discord community engagement, and add a demo video. Configuration changes enable an announcement banner and Discord social icon, while a minor VirtualService YAML adjustment updates a host value. Minor CSS whitespace cleanup is included. Additionally, a GitHub Actions workflow step and a Makefile target were added to fetch contributors data via a new Python script. A new blog post about scale-to-zero Kubernetes deployments was also added. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ContributorsPage
participant GitHubAPI
User->>ContributorsPage: Load page
ContributorsPage->>GitHubAPI: Fetch contributors for truefoundry/elasti
GitHubAPI-->>ContributorsPage: Return contributor data
ContributorsPage->>ContributorsPage: Filter out bots
ContributorsPage->>User: Render contributors grid or error/loading message
sequenceDiagram
participant CI as GitHub Actions
participant Script as fetch_contributors.py
participant GitHubAPI
CI->>Script: Run fetch_contributors.py with GITHUB_TOKEN
Script->>GitHubAPI: Request contributors list
GitHubAPI-->>Script: Return contributors data
Script->>Script: Filter bots and simplify data
Script->>CI: Save contributors.json for docs
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
docs/index.md(4 hunks)docs/src/dev-contributors.md(1 hunks)docs/stylesheets/extra.css(0 hunks)mkdocs.yml(3 hunks)playground/config/demo-virtualService.yaml(1 hunks)
💤 Files with no reviewable changes (1)
- docs/stylesheets/extra.css
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/index.md
20-20: Inline HTML
Element: a
(MD033, no-inline-html)
117-117: Inline HTML
Element: h2
(MD033, no-inline-html)
157-157: Inline HTML
Element: div
(MD033, no-inline-html)
158-158: Inline HTML
Element: h2
(MD033, no-inline-html)
159-159: Inline HTML
Element: div
(MD033, no-inline-html)
159-159: Inline HTML
Element: iframe
(MD033, no-inline-html)
171-171: Inline HTML
Element: a
(MD033, no-inline-html)
172-172: Inline HTML
Element: span
(MD033, no-inline-html)
173-173: Inline HTML
Element: span
(MD033, no-inline-html)
docs/src/dev-contributors.md
6-6: Multiple top-level headings in the same document
(MD025, single-title, single-h1)
10-10: Inline HTML
Element: br
(MD033, no-inline-html)
12-12: Inline HTML
Element: div
(MD033, no-inline-html)
14-14: Inline HTML
Element: p
(MD033, no-inline-html)
17-17: Inline HTML
Element: script
(MD033, no-inline-html)
22-22: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
26-26: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
28-28: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
31-31: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
52-52: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
55-55: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
61-61: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
72-72: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
81-81: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
86-86: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
91-91: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
95-95: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
99-99: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
104-104: Inline HTML
Element: style
(MD033, no-inline-html)
🪛 LanguageTool
docs/src/dev-contributors.md
[grammar] ~6-~6: Use correct spacing
Context: ...butors to the KubeElasti project --- # Contributors This page recognizes all the amazing peo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[style] ~8-~8: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...tributors This page recognizes all the amazing people who have contributed to the Kube...
(AWESOME)
[grammar] ~8-~8: Use correct spacing
Context: ...o documentation, testing, and community support.
Loading contributors...
GitHub API responded with status: ${response.status}); } const contributors = await response.json(); // Clear loading message document.querySelector('#contributors-grid .loading-message').remove(); // Filter out bot accounts const botPatterns = [ /-bot$/i, // ends with -bot /-automation$/i, // ends with -automation /[bot]$/i, // ends with [bot] /^dependabot/i, // starts with dependabot /^renovate/i, // starts with renovate /^github-actions/i, // starts with github-actions /^semantic-release/i, // starts with semantic-release /^imgbot/i, // starts with imgbot /^codecov/i, // starts with codecov /^snyk/i, // starts with snyk /^greenkeeper/i, // starts with greenkeeper /^depfu/i, // starts with depfu /^pyup-bot/i, // starts with pyup-bot ]; const isBot = (username) => { return botPatterns.some(pattern => pattern.test(username)); }; // Filter and display human contributors only const humanContributors = contributors.filter(contributor => !isBot(contributor.login)); // Process and display contributors humanContributors.forEach(contributor => { const contributorElement = createContributorElement(contributor); document.getElementById('contributors-grid').appendChild(contributorElement); }); // Show message if no human contributors found (unlikely but just in case) if (humanContributors.length === 0) { const message = document.createElement('p'); message.textContent = 'No contributors found.'; document.getElementById('contributors-grid').appendChild(message); } } catch (error) { console.error('Error fetching contributors:', error); const errorMessage = document.createElement('p'); errorMessage.textContent = 'Unable to load contributors. Please check back later.'; document.getElementById('contributors-grid').innerHTML = ''; document.getElementById('contributors-grid').appendChild(errorMessage); } }); function createContributorElement(contributor) { const container = document.createElement('div'); container.className = 'contributor'; const link = document.createElement('a'); link.href = contributor.html_url; link.target = '_blank'; link.rel = 'noopener noreferrer'; const avatar = document.createElement('img'); avatar.src = contributor.avatar_url; avatar.alt = ${contributor.login}'s avatar; avatar.loading = 'lazy'; const name = document.createElement('div'); name.className = 'contributor-name'; name.textContent = contributor.login; link.appendChild(avatar); container.appendChild(link); container.appendChild(name); return container; } </script> <style> .contributors-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(100px, 1fr)); gap: 15px; margin: 20px 0; } .contributor { display: flex; flex-direction: column; align-items: center; text-align: center; padding: 8px; border-radius: 6px; transition: transform 0.2s, box-shadow 0.2s; } .contributor:hover { transform: translateY(-3px); box-shadow: 0 3px 10px rgba(0, 0, 0, 0.1); } .contributor img { width: 60px; height: 60px; border-radius: 50%; object-fit: cover; margin-bottom: 8px; } .contributor-name { font-weight: bold; font-size: 0.9em; } .loading-message { grid-column: 1 / -1; text-align: center; padding: 20px; } </style>
(QB_NEW_EN_OTHER_ERROR_IDS_5)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/pkg)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/resolver)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/operator)
- GitHub Check: Run Kuttl E2E Tests
🔇 Additional comments (3)
mkdocs.yml (3)
40-42:announce.dismissrequires Material ≥ 9.4The
announce.dismissfeature was introduced in newer releases of the Material theme.
Make sure your deploy pipeline pins a recent enough version, otherwise the site will fail to build.
109-117: Solid addition – banner + Discord links look correctIndentation and key placement under
extra:are valid YAML; the banner will render as expected and the Discord icon will appear in the header.
141-144: Nav entry added for Contributors page – No issues spotted.Path
src/dev-contributors.mdmatches the new file location, so the link will resolve.
There was a problem hiding this comment.
Actionable comments posted: 6
♻️ Duplicate comments (1)
docs/index.md (1)
20-20: Previous accessibility concern has been addressed.The
rel="noopener noreferrer"attribute has been properly added to the Discord community link, addressing the security concern from previous reviews.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (6)
.github/workflows/docs.yaml(1 hunks)Makefile(1 hunks)docs/assets/contributors.json(1 hunks)docs/index.md(4 hunks)docs/scripts/fetch_contributors.py(1 hunks)docs/src/dev-contributors.md(1 hunks)
🧰 Additional context used
🪛 checkmake (0.2.2)
Makefile
[warning] 61-61: Missing required phony target "all"
(minphony)
[warning] 61-61: Missing required phony target "clean"
(minphony)
🪛 markdownlint-cli2 (0.17.2)
docs/index.md
20-20: Inline HTML
Element: a
(MD033, no-inline-html)
117-117: Inline HTML
Element: h2
(MD033, no-inline-html)
157-157: Inline HTML
Element: div
(MD033, no-inline-html)
158-158: Inline HTML
Element: h2
(MD033, no-inline-html)
159-159: Inline HTML
Element: div
(MD033, no-inline-html)
161-161: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
161-161: Inline HTML
Element: iframe
(MD033, no-inline-html)
162-162: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
163-163: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
164-164: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
165-165: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
166-166: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
183-183: Inline HTML
Element: a
(MD033, no-inline-html)
184-184: Inline HTML
Element: span
(MD033, no-inline-html)
185-185: Inline HTML
Element: span
(MD033, no-inline-html)
docs/src/dev-contributors.md
8-8: Inline HTML
Element: div
(MD033, no-inline-html)
8-8: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
9-9: Inline HTML
Element: div
(MD033, no-inline-html)
10-10: Inline HTML
Element: div
(MD033, no-inline-html)
12-12: Inline HTML
Element: h1
(MD033, no-inline-html)
14-14: Inline HTML
Element: p
(MD033, no-inline-html)
15-15: Inline HTML
Element: p
(MD033, no-inline-html)
16-16: Inline HTML
Element: br
(MD033, no-inline-html)
16-16: Inline HTML
Element: br
(MD033, no-inline-html)
17-17: Inline HTML
Element: b
(MD033, no-inline-html)
17-17: Inline HTML
Element: b
(MD033, no-inline-html)
17-17: Inline HTML
Element: b
(MD033, no-inline-html)
18-18: Inline HTML
Element: div
(MD033, no-inline-html)
19-19: Inline HTML
Element: a
(MD033, no-inline-html)
20-20: Inline HTML
Element: a
(MD033, no-inline-html)
23-23: Inline HTML
Element: div
(MD033, no-inline-html)
24-24: Inline HTML
Element: img
(MD033, no-inline-html)
39-39: Inline HTML
Element: div
(MD033, no-inline-html)
40-40: Inline HTML
Element: h2
(MD033, no-inline-html)
41-41: Inline HTML
Element: div
(MD033, no-inline-html)
42-42: Inline HTML
Element: div
(MD033, no-inline-html)
43-43: Inline HTML
Element: div
(MD033, no-inline-html)
44-44: Inline HTML
Element: h3
(MD033, no-inline-html)
45-45: Inline HTML
Element: p
(MD033, no-inline-html)
47-47: Inline HTML
Element: div
(MD033, no-inline-html)
48-48: Inline HTML
Element: div
(MD033, no-inline-html)
49-49: Inline HTML
Element: h3
(MD033, no-inline-html)
50-50: Inline HTML
Element: p
(MD033, no-inline-html)
52-52: Inline HTML
Element: div
(MD033, no-inline-html)
53-53: Inline HTML
Element: div
(MD033, no-inline-html)
54-54: Inline HTML
Element: h3
(MD033, no-inline-html)
55-55: Inline HTML
Element: p
(MD033, no-inline-html)
57-57: Inline HTML
Element: div
(MD033, no-inline-html)
58-58: Inline HTML
Element: div
(MD033, no-inline-html)
59-59: Inline HTML
Element: h3
(MD033, no-inline-html)
60-60: Inline HTML
Element: p
(MD033, no-inline-html)
62-62: Inline HTML
Element: div
(MD033, no-inline-html)
63-63: Inline HTML
Element: div
(MD033, no-inline-html)
64-64: Inline HTML
Element: h3
(MD033, no-inline-html)
65-65: Inline HTML
Element: p
(MD033, no-inline-html)
67-67: Inline HTML
Element: div
(MD033, no-inline-html)
68-68: Inline HTML
Element: div
(MD033, no-inline-html)
69-69: Inline HTML
Element: h3
(MD033, no-inline-html)
70-70: Inline HTML
Element: p
(MD033, no-inline-html)
76-76: Inline HTML
Element: div
(MD033, no-inline-html)
77-77: Inline HTML
Element: h2
(MD033, no-inline-html)
78-78: Inline HTML
Element: div
(MD033, no-inline-html)
79-79: Inline HTML
Element: div
(MD033, no-inline-html)
80-80: Inline HTML
Element: img
(MD033, no-inline-html)
82-82: Inline HTML
Element: div
(MD033, no-inline-html)
83-83: Inline HTML
Element: div
(MD033, no-inline-html)
84-84: Inline HTML
Element: div
(MD033, no-inline-html)
85-85: Inline HTML
Element: div
(MD033, no-inline-html)
86-86: Inline HTML
Element: h3
(MD033, no-inline-html)
87-87: Inline HTML
Element: p
(MD033, no-inline-html)
90-90: Inline HTML
Element: div
(MD033, no-inline-html)
91-91: Inline HTML
Element: div
(MD033, no-inline-html)
92-92: Inline HTML
Element: div
(MD033, no-inline-html)
93-93: Inline HTML
Element: h3
(MD033, no-inline-html)
94-94: Inline HTML
Element: p
(MD033, no-inline-html)
97-97: Inline HTML
Element: div
(MD033, no-inline-html)
98-98: Inline HTML
Element: div
(MD033, no-inline-html)
99-99: Inline HTML
Element: div
(MD033, no-inline-html)
100-100: Inline HTML
Element: h3
(MD033, no-inline-html)
101-101: Inline HTML
Element: p
(MD033, no-inline-html)
104-104: Inline HTML
Element: div
(MD033, no-inline-html)
105-105: Inline HTML
Element: div
(MD033, no-inline-html)
106-106: Inline HTML
Element: div
(MD033, no-inline-html)
107-107: Inline HTML
Element: h3
(MD033, no-inline-html)
108-108: Inline HTML
Element: p
(MD033, no-inline-html)
116-116: Inline HTML
Element: div
(MD033, no-inline-html)
117-117: Inline HTML
Element: h2
(MD033, no-inline-html)
118-118: Inline HTML
Element: div
(MD033, no-inline-html)
119-119: Inline HTML
Element: div
(MD033, no-inline-html)
120-120: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
120-120: Inline HTML
Element: pre
(MD033, no-inline-html)
120-120: Inline HTML
Element: code
(MD033, no-inline-html)
🪛 Ruff (0.12.2)
docs/scripts/fetch_contributors.py
1-1: Shebang is present but file is not executable
(EXE001)
36-36: Missing return type annotation for public function is_bot
(ANN201)
36-36: Missing type annotation for function argument username
(ANN001)
40-40: Missing return type annotation for public function fetch_contributors
(ANN201)
51-51: Audit URL open for permitted schemes. Allowing use of file: or custom schemes is often unexpected.
(S310)
52-52: Audit URL open for permitted schemes. Allowing use of file: or custom schemes is often unexpected.
(S310)
62-62: Missing return type annotation for public function filter_and_simplify_contributors
(ANN201)
62-62: Missing type annotation for function argument contributors
(ANN001)
76-76: Trailing comma missing
Add trailing comma
(COM812)
81-81: Missing return type annotation for public function main
Add return type annotation: int
(ANN201)
🪛 LanguageTool
docs/src/dev-contributors.md
[style] ~6-~6: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...oject --- This page recognizes all the amazing people who have contributed to the Kube...
(AWESOME)
[grammar] ~6-~6: Use correct spacing
Context: ...o documentation, testing, and community support.
Loading contributors...
Failed to load contributors: ${response.status}); } const contributors = await response.json(); // Clear loading message document.querySelector('#contributors-grid .loading-message').remove(); // Process and display contributors contributors.forEach(contributor => { const contributorElement = createContributorElement(contributor); document.getElementById('contributors-grid').appendChild(contributorElement); }); // Show message if no contributors found if (contributors.length === 0) { const message = document.createElement('p'); message.textContent = 'No contributors found.'; document.getElementById('contributors-grid').appendChild(message); } } catch (error) { console.error('Error fetching contributors:', error); const errorMessage = document.createElement('p'); errorMessage.textContent = 'Unable to load contributors. Please check back later.'; document.getElementById('contributors-grid').innerHTML = ''; document.getElementById('contributors-grid').appendChild(errorMessage); } }); function createContributorElement(contributor) { const container = document.createElement('div'); container.className = 'contributor'; const link = document.createElement('a'); link.href = contributor.html_url; link.target = '_blank'; link.rel = 'noopener noreferrer'; const avatar = document.createElement('img'); avatar.src = contributor.avatar_url; avatar.alt = ${contributor.login}'s avatar; avatar.loading = 'lazy'; const name = document.createElement('div'); name.className = 'contributor-name'; name.textContent = contributor.login; link.appendChild(avatar); container.appendChild(link); container.appendChild(name); return container; } </script> <style> .contributors-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(100px, 1fr)); gap: 15px; margin: 20px 0; } .contributor { display: flex; flex-direction: column; align-items: center; text-align: center; padding: 8px; border-radius: 6px; transition: transform 0.2s, box-shadow 0.2s; } .contributor:hover { transform: translateY(-3px); box-shadow: 0 3px 10px rgba(0, 0, 0, 0.1); } .contributor img { width: 60px; height: 60px; border-radius: 50%; object-fit: cover; margin-bottom: 8px; } .contributor-name { font-weight: bold; font-size: 0.9em; } .loading-message { grid-column: 1 / -1; text-align: center; padding: 20px; } </style>
(QB_NEW_EN_OTHER_ERROR_IDS_5)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/pkg)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/resolver)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/operator)
- GitHub Check: Run Kuttl E2E Tests
🔇 Additional comments (9)
docs/scripts/fetch_contributors.py (3)
20-34: Comprehensive bot filtering patterns.The bot detection patterns cover a wide range of common bot naming conventions, which is excellent for filtering automated accounts from the contributors list.
40-60: Robust API interaction with proper error handling.The function correctly handles authentication, HTTP errors, and network issues. The use of GitHub token from environment variables is a good security practice.
81-104: Well-structured main function with clear flow.The main function provides good user feedback and proper error handling with appropriate exit codes.
docs/assets/contributors.json (1)
1-1: Generated contributor data structure is correct.The JSON file contains the expected contributor data with appropriate fields (login, avatar_url, html_url). Since this is generated content from the fetch script, the compact formatting is acceptable.
Makefile (1)
61-63: Clean integration with existing Makefile structure.The new
fetch-contributorstarget follows the established pattern and provides a convenient way to manually update the contributors data..github/workflows/docs.yaml (1)
34-38: Proper workflow integration for automated contributor updates.The step is correctly positioned in the workflow and uses the appropriate GITHUB_TOKEN for API access. This ensures the contributors list stays current with each documentation deployment.
docs/index.md (3)
117-117: Clear and accurate heading update.The change from "1 Command" to "1 File" better reflects the actual setup process shown in the code example below.
167-167: Good accessibility practice with iframe title.The iframe includes a descriptive title attribute, which addresses accessibility concerns for screen readers.
183-186: Enhanced community engagement with Discord integration.The addition of a Discord community link improves user engagement options and aligns with the overall community focus of this PR.
There was a problem hiding this comment.
Actionable comments posted: 5
🔭 Outside diff range comments (1)
mkdocs.yml (1)
145-147: Trailing whitespace breaks YAML lintingYAMLlint flags trailing spaces on the “Blog” nav entry.
- - Blog: - - Blog: blog/index.md + - Blog: + - Blog: blog/index.md
♻️ Duplicate comments (2)
docs/src/dev-contributors.md (2)
8-9: Remove unnecessary<br>to satisfy MD033A blank line in Markdown yields the same spacing and avoids the inline-HTML lint error.
-<br> +
20-21: Absolute path will 404 when site is hosted under a sub-path
fetch('/assets/contributors.json')assumes the site root is/.
GitHub Pages and other static hosts often publish MkDocs sites at/project/, causing the request to miss.- const response = await fetch('/assets/contributors.json'); + const response = await fetch('assets/contributors.json'); // relative URL works in root and sub-paths
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
docs/blog/posts/ScaleToZero.md(1 hunks)docs/index.md(4 hunks)docs/src/dev-contributors.md(1 hunks)mkdocs.yml(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/dev-contributors.md
[grammar] ~6-~6: Use correct spacing
Context: ...o documentation, testing, and community support.
Loading contributors...
Failed to load contributors: ${response.status}); } const contributors = await response.json(); // Clear loading message document.querySelector('#contributors-grid .loading-message').remove(); // Process and display contributors contributors.forEach(contributor => { const contributorElement = createContributorElement(contributor); document.getElementById('contributors-grid').appendChild(contributorElement); }); // Show message if no contributors found if (contributors.length === 0) { const message = document.createElement('p'); message.textContent = 'No contributors found.'; document.getElementById('contributors-grid').appendChild(message); } } catch (error) { console.error('Error fetching contributors:', error); const errorMessage = document.createElement('p'); errorMessage.textContent = 'Unable to load contributors. Please check back later.'; document.getElementById('contributors-grid').innerHTML = ''; document.getElementById('contributors-grid').appendChild(errorMessage); } }); function createContributorElement(contributor) { const container = document.createElement('div'); container.className = 'contributor'; const link = document.createElement('a'); link.href = contributor.html_url; link.target = '_blank'; link.rel = 'noopener noreferrer'; const avatar = document.createElement('img'); avatar.src = contributor.avatar_url; avatar.alt = ${contributor.login}'s avatar; avatar.loading = 'lazy'; const name = document.createElement('div'); name.className = 'contributor-name'; name.textContent = contributor.login; link.appendChild(avatar); container.appendChild(link); container.appendChild(name); return container; } </script> <style> .contributors-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(100px, 1fr)); gap: 15px; margin: 20px 0; } .contributor { display: flex; flex-direction: column; align-items: center; text-align: center; padding: 8px; border-radius: 6px; transition: transform 0.2s, box-shadow 0.2s; } .contributor:hover { transform: translateY(-3px); box-shadow: 0 3px 10px rgba(0, 0, 0, 0.1); } .contributor img { width: 60px; height: 60px; border-radius: 50%; object-fit: cover; margin-bottom: 8px; } .contributor-name { font-weight: bold; font-size: 0.9em; } .loading-message { grid-column: 1 / -1; text-align: center; padding: 20px; } </style>
(QB_NEW_EN_OTHER_ERROR_IDS_5)
docs/blog/posts/ScaleToZero.md
[grammar] ~12-~12: Use correct spacing
Context: ...n Kubernetes: Save Costs Without Losing Traffic If you've ever deployed HTTP services on...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~14-~14: Use correct spacing
Context: ...that burn resources during off-hours or inactivity. In today's blog, we dive into the concep...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~16-~16: Use correct spacing
Context: ...ro request loss**, and zero lingering proxies. ## What is Scale-to-Zero? *Scale-to-Zero...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~21-~21: Use correct spacing
Context: ... proxies**. ## What is Scale-to-Zero? Scale-to-Zero refers to the ability to...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~23-~23: There might be a mistake here.
Context: ...tically scale down a deployment to zero replicas — effectively turning off the service ...
(QB_NEW_EN_OTHER)
[grammar] ~23-~23: There might be a mistake here.
Context: ...licas — effectively turning off the service — when it's idle, and scaling it back up w...
(QB_NEW_EN_OTHER)
[grammar] ~23-~23: There might be a mistake here.
Context: ...turning off the service — when it's idle, and scaling it back up when traffic re...
(QB_NEW_EN_OTHER)
[grammar] ~23-~23: Use correct spacing
Context: ...le, and scaling it back up when traffic resumes. This is ideal for: - Internal or develo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~25-~25: There might be a mistake here.
Context: ...up when traffic resumes. This is ideal for: - Internal or development environments - ...
(QB_NEW_EN_OTHER)
[grammar] ~30-~30: Use correct spacing
Context: ... services (e.g., licensed software, GPU workloads) ## Why Use Scale-to-Zero? There are many r...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~34-~34: Use correct spacing
Context: ... software, GPU workloads) ## Why Use Scale-to-Zero? There are many reasons to use scale-to-z...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~36-~36: There might be a mistake here.
Context: ...to-Zero? There are many reasons to use scale-to-zero: - Cost savings: You're always paying fo...
(QB_NEW_EN_OTHER)
[grammar] ~38-~38: There might be a mistake here.
Context: ...: You're always paying for at least one pod - Cold-start savings: Cold-start savings...
(QB_NEW_EN_OTHER)
[grammar] ~39-~39: There might be a mistake here.
Context: ...s**: Cold-start savings are left on the table - Infrequently accessed services: Infreq...
(QB_NEW_EN_OTHER)
[grammar] ~40-~40: Use proper capitalization
Context: ...ccessed services still waste memory and CPU Scale-to-Zero solves this by **removing ...
(QB_NEW_EN_OTHER_ERROR_IDS_6)
[grammar] ~42-~42: Use correct spacing
Context: ...hing handles the scale-up and request buffering. ## Scale-to-Zero: Architectural View Here'...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~44-~44: Use correct spacing
Context: ...ering. ## Scale-to-Zero: Architectural View Here's how a scale-to-zero system typica...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~46-~46: There might be a mistake here.
Context: ...'s how a scale-to-zero system typically works: mermaid sequenceDiagram participant User participant Proxy participant Operator participant Deployment participant Pod User->>Proxy: HTTP Request Proxy-->>Operator: Pod is down, trigger scale-up Operator->>Deployment: Scale replicas = 1 Deployment->>Pod: Start new pod Proxy-->>Pod: Forward request after pod is ready ### Challenges * Traffic ca...
(QB_NEW_EN_OTHER)
[grammar] ~67-~67: Use articles correctly
Context: ...* Proxy needs to exit the path once pod is alive (for performance). ## How K...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~67-~67: Use correct spacing
Context: ...exit the path* once pod is alive (for performance). ## How KubeElasti Solves Scale-to-Zero [**...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~71-~71: Use correct spacing
Context: ...rformance). ## How KubeElasti Solves Scale-to-Zero [KubeElasti](https://github.com/truefou...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~73-~73: There might be a problem here.
Context: ...s scale-to-zero to your existing HTTP services — without any rewrites, packaging changes, or ven...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~73-~73: Use correct spacing
Context: ... rewrites, packaging changes, or vendor lock-in. ### How it works: 1. Idle Timeout: If y...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~75-~75: There might be a mistake here.
Context: ...changes, or vendor lock-in. ### How it works: 1. Idle Timeout: If your service sees no...
(QB_NEW_EN_OTHER)
[grammar] ~80-~80: Use correct spacing
Context: ... forwards the request and exits the path. mermaid flowchart TB User[User] -->|HTTP Request| ElastiProxy ElastiProxy -->|Pod Not Found| KubeElastiOperator KubeElastiOperator -->|Scale Up| Deployment Deployment --> Pod ElastiProxy -->|Forward| Pod ## What Makes KubeElasti Different? Unlike...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~92-~92: Use correct spacing
Context: ...ard| Pod ``` ## What Makes KubeElasti Different? Unlike Knative, KEDA, or OpenFaaS — whic...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~94-~94: There might be a mistake here.
Context: ...ti Different? Unlike Knative, KEDA, or OpenFaaS — which require new runtimes, complex setu...
(QB_NEW_EN_OTHER)
[grammar] ~94-~94: Use the right verb tense
Context: ...equire new runtimes, complex setups, or stay in the path — **KubeElasti is minimal a...
(QB_NEW_EN_OTHER_ERROR_IDS_13)
[grammar] ~94-~94: There might be a problem here.
Context: ...untimes, complex setups, or stay in the path — KubeElasti is minimal and transparent. ### Feature...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~94-~94: Use correct spacing
Context: ... the path — KubeElasti is minimal and transparent. ### Feature Comparison | Feature ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~96-~96: Use correct spacing
Context: ...minimal and transparent.** ### Feature Comparison | Feature | **KubeE...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~107-~107: Use correct spacing
Context: ...🔹 Medium | ## Trade-offs and Limitations Like any focused tool, KubeElasti makes ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~109-~109: There might be a mistake here.
Context: ...any focused tool, KubeElasti makes some trade-offs: * ✅ HTTP-only support (for now) — gRPC/TC...
(QB_NEW_EN_OTHER)
[grammar] ~111-~111: There might be a problem here.
Context: ...trade-offs: * ✅ HTTP-only support (for now) — gRPC/TCP support is in roadmap. * ✅ Only Pro...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~111-~111: Use articles correctly
Context: ...port (for now) — gRPC/TCP support is in roadmap. * ✅ Only Prometheus metrics are support...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~113-~113: There might be a problem here.
Context: ...on. * ✅ Works with Deployments & Argo Rollouts — more types to come. That said, it gives you **pro...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~113-~113: Use correct spacing
Context: ...ments & Argo Rollouts** — more types to come. That said, it gives you **production-rea...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~115-~115: Use correct spacing
Context: ...observability and battle-tested scaling behavior. ## Final Thoughts Scale-to-Zero is no long...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~118-~118: Use correct spacing
Context: ...tle-tested scaling behavior. ## Final Thoughts Scale-to-Zero is no longer a "nice-to-ha...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~120-~120: Use hyphens correctly
Context: ... Scale-to-Zero is no longer a "nice-to-have" — it's a **cost-saving, resilience-enha...
(QB_NEW_EN_OTHER_ERROR_IDS_29)
[grammar] ~120-~120: Use correct spacing
Context: ...silience-enhancing pattern** for modern infrastructure. With KubeElasti, you can implement it **...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~122-~122: Use correct spacing
Context: ...FaaS platforms**, and without request failures. Want to give it a spin? Start here: * ?...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~124-~124: There might be a mistake here.
Context: ...lures**. Want to give it a spin? Start here: * 🧪 Quickstart: [Get Started Guide](/src...
(QB_NEW_EN_OTHER)
[grammar] ~126-~126: There might be a mistake here.
Context: ...rt here: * 🧪 Quickstart: Get Started Guide * 🧩 Source Code: [KubeElasti on GitHub](h...
(QB_NEW_EN_OTHER)
[grammar] ~127-~127: There might be a mistake here.
Context: ...etup/) * 🧩 Source Code: KubeElasti on GitHub
(QB_NEW_EN_OTHER)
🪛 YAMLlint (1.37.1)
mkdocs.yml
[error] 145-145: trailing spaces
(trailing-spaces)
🪛 markdownlint-cli2 (0.17.2)
docs/blog/posts/ScaleToZero.md
8-8: Inline HTML
Element: br
(MD033, no-inline-html)
10-10: Inline HTML
Element: div
(MD033, no-inline-html)
12-12: Inline HTML
Element: p
(MD033, no-inline-html)
15-15: Inline HTML
Element: script
(MD033, no-inline-html)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
25-25: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
27-27: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
30-30: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
36-36: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
47-47: Trailing spaces
Expected: 0 or 2; Actual: 6
(MD009, no-trailing-spaces)
56-56: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
61-61: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
66-66: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
70-70: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
74-74: Trailing spaces
Expected: 0 or 2; Actual: 4
(MD009, no-trailing-spaces)
79-79: Inline HTML
Element: style
(MD033, no-inline-html)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/resolver)
- GitHub Check: golangci-lint (/home/runner/work/KubeElasti/KubeElasti/operator)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/pkg)
- GitHub Check: test (/home/runner/work/KubeElasti/KubeElasti/operator)
- GitHub Check: Run Kuttl E2E Tests
🔇 Additional comments (2)
mkdocs.yml (1)
104-108: Verifyblogplugin availability in build pipeline
blogis now listed underplugins, but MkDocs does not ship a built-in blog plugin.
Ensure that the corresponding third-party package (commonlymkdocs-blog-plugin) is pinned inrequirements.txt/docs/requirements.txtand installed in the CI image, otherwise the docs build will fail.docs/index.md (1)
18-21:rel="noopener noreferrer"correctly added – nice!The Discord CTA button now follows the security best-practice that was requested in a previous review.
Description
This PR is to add following to the documentation
Type of change
Checklist:
Summary by CodeRabbit
New Features
Improvements
Bug Fixes
Chores