Consolidate Websites#404
Conversation
WalkthroughThe pull request updates several documentation and configuration files. The Changes
Sequence Diagram(s)sequenceDiagram
participant Page as Documentation Page
participant Template as Page Template
Page->>Template: Render page (pagename passed)
alt pagename is not "index"
Template->>Page: Display warning message (active update notice)
else pagename equals "index"
Template->>Page: Render page without warning
end
Possibly related PRs
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
✅ Deploy Preview for jumpstarter-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/source/_static/img/logo-dark-theme.svgis excluded by!**/*.svgdocs/source/_static/img/logo-light-theme.svgis excluded by!**/*.svg
📒 Files selected for processing (9)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)docs/source/_static/css/custom.css(1 hunks)docs/source/_templates/head.html(1 hunks)docs/source/_templates/page.html(1 hunks)docs/source/conf.py(3 hunks)docs/source/index.md(2 hunks)docs/source/installation/python-package.md(1 hunks)docs/source/introduction/adapters.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: pytest-matrix (3.13)
- GitHub Check: pytest-matrix (3.11)
- GitHub Check: pytest-matrix (3.12)
- GitHub Check: e2e
🔇 Additional comments (15)
docs/source/_templates/page.html (1)
7-12: Conditional Warning Message Integration.
The new conditional block clearly displays the warning message for non-index pages. This effectively informs users that the documentation is a work in progress. Ensure that any redirection logic for consolidating domains (i.e. redirecting docs.jumpstarter.dev to jumpstarter.dev) is handled at the server or configuration level.docs/source/installation/python-package.md (2)
5-5: Updated Package URL for Consolidated Domain.
The URL for the Jumpstarter Python packages has been updated to "https://jumpstarter.dev/packages/". This aligns with the PR objective of consolidating the websites.
13-13: Revised pip Installation Command.
The installation command now uses "https://jumpstarter.dev/packages/simple", ensuring that users pull packages from the new domain. Please verify that the package index routes correctly after consolidation.docs/source/index.md (2)
3-23: Enhanced Resource Badge Integration.
The addition of badges for GitHub, PyPI, Matrix Chat, Etherpad Notes, and Weekly Meeting improves quick access to key resources. The URLs and alt texts are clear and reflect the new resource endpoints.
58-72: Navigation Toctree Verification.
The toctree block appears standard and well-organized. Please ensure that all entries remain up-to-date, especially in light of the website consolidation.docs/source/_static/css/custom.css (2)
10-14: Improved Sidebar Brand Text Styling.
The new CSS properties for.sidebar-brand .sidebar-brand-textcorrectly address text overflow issues by enabling normal white-space handling and word breaking. This ensures that longer version names or brand text display properly.
16-21: Enhanced Sidebar Link Formatting.
The CSS rules for.sidebar-brand .sidebar-brand-text a(usingoverflow: hidden,text-overflow: ellipsis, andmax-width: 100%) ensure that sidebar links remain clean and do not break the layout.README.md (2)
3-7: Consistent Resource Badges in README.
The addition of badges for PyPI, Matrix, Etherpad, and Community Meeting provides immediate visual links to key resources. This update supports the consolidation by clearly directing users to relevant content.
10-10: Updated Documentation Link.
The documentation link now routes to "https://jumpstarter.dev", which is perfectly aligned with the consolidation strategy. Please verify that this URL is actively served and that any legacy links (e.g., from docs.jumpstarter.dev) are properly redirected.docs/source/introduction/adapters.md (1)
16-23: Good use of include directive for content reuse!This is an excellent approach to documentation maintenance by reusing content from the API reference rather than duplicating it. Using the include directive with specific start/end markers keeps the documentation DRY and ensures consistency across the consolidated website.
docs/source/_templates/head.html (1)
1-3: Improved Open Graph meta tags for social sharingThe updated title and description provide a more formal, comprehensive representation of Jumpstarter when links are shared on social media platforms. The revised description effectively highlights the key benefits and features of the tool.
docs/source/conf.py (3)
18-18: Good update to author attributionChanging from "Jumpstarter Community" to "Jumpstarter Contributors" is more precise and aligned with standard open source project practices.
47-47: Consistent title updateThis change aligns with the Open Graph meta tag update in head.html, maintaining consistency across the documentation.
95-106: Good multiversion configuration additionsThe added configurations for static files and include patterns ensure proper handling of resources across documentation versions, which is essential for the website consolidation.
CONTRIBUTING.md (1)
5-15: Excellent community resource additionsThe new "Getting Help" section provides specific, actionable resources for contributors seeking assistance. The documentation link correctly points to jumpstarter.dev instead of docs.jumpstarter.dev, aligning perfectly with the PR objective of consolidating the websites.
|
@kirkbrauer @mangelajo what are your thoughts on this? |
|
It looks good to me I prefer Kirk's base readme.md from the other pr but otherwise it looks good |
kirkbrauer
left a comment
kirkbrauer
left a comment
There was a problem hiding this comment.
Looks good a few tweaks, I think we should add back some of the badges for now as the PyPi package is not pushed yet. Also, I like the custom Jumpstarter badge 😉
Co-authored-by: Kirk Brauer <kirkebrauer@gmail.com>
raballew
force-pushed
the
consolidate-websites
branch
from
f1844e1 to
d5d0579
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/source/index.md (1)
25-25: Style Consistency: Compound Adjectives
The line “Jumpstarter is a free and open source testing tool…” uses “open source” without a hyphen. Verify that this style (omitting the hyphen) is intentional and consistently applied across all documentation as part of the recent style update.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Meeting ``` Jumpstarter is a free and open source testing tool that bridges the gap betwe...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/source/introduction/index.md (1)
1-10: Clear and Updated Introduction Section
The introduction clearly explains Jumpstarter’s purpose while emphasizing its free and open source nature. The modification—using “open source” (without a hyphen)—appears intentional as part of the broader documentation update. Ensure that this stylistic choice is uniformly applied throughout all documents.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Introduction Jumpstarter is a free and open source testing tool that enables you to test y...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nsive and inaccessible to hobbyists and open source projects. Jumpstarter provides powerfu...(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md (2)
8-8: Consistent Branding and Messaging
The one-line description succinctly communicates Jumpstarter’s value proposition. Just ensure that the treatment of compound adjectives like “open source” is consistently applied (i.e. deliberately avoiding a hyphen) across the documentation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .../meet.google.com/gzd-hhbd-hpu) A free, open source tool for automated testing on real and ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
37-51: Updated Documentation and License References
The Documentation, Contributing, and License sections have been updated with relative links and references that now reflect the consolidated website. It’s worth a final check to ensure that all external resource links (if any) are also revised to use jumpstarter.dev where applicable.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.md(1 hunks)docs/source/_templates/head.html(1 hunks)docs/source/index.md(2 hunks)docs/source/introduction/index.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/source/_templates/head.html
🧰 Additional context used
🪛 LanguageTool
docs/source/index.md
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Meeting ``` Jumpstarter is a free and open source testing tool that bridges the gap betwe...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md
[style] ~3-~3: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1737 characters long)
Context: ...(https://pypi.org/project/jumpstarter/) 
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~8-~8: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .../meet.google.com/gzd-hhbd-hpu) A free, open source tool for automated testing on real and ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/source/introduction/index.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Introduction Jumpstarter is a free and open source testing tool that enables you to test y...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nsive and inaccessible to hobbyists and open source projects. Jumpstarter provides powerfu...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: pytest-matrix (3.12)
- GitHub Check: pytest-matrix (3.13)
- GitHub Check: pytest-matrix (3.11)
- GitHub Check: e2e
🔇 Additional comments (4)
docs/source/index.md (2)
3-23: Enhancement: Added Badge Images for External Resources
The new badges for GitHub, PyPI, Matrix, Etherpad, and Weekly Meeting enhance the documentation’s visual appeal and provide direct links to key external resources. Please verify that these badge targets align with the consolidation objective (i.e. ensuring that any links pointing to docs.jumpstarter.dev are appropriately redirected to jumpstarter.dev).
27-31: Smart Reuse via Include Directive
Using the{include}directive to pull in the Highlights section from README.md helps maintain a single source of truth. This reduces duplication and ensures that changes made in the README are automatically reflected here. Just double-check that the included segment is fully up-to-date with the consolidated site’s messaging.README.md (2)
1-6: Updated Badges Reflecting the Consolidated Domain
The updated badges (for PyPI, Matrix, Etherpad, and Community Meeting) now use the correct links aligned with jumpstarter.dev. This matches the consolidation objective and improves consistency across the project’s online presence.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1737 characters long)
Context: ...(https://pypi.org/project/jumpstarter/)[
23-25: Installation Instructions Using the Consolidated Domain
The installation commands now reference “https://jumpstarter.dev/packages/simple,” which is in line with the consolidation initiative. This update should facilitate package retrieval directly from the new unified domain.Also applies to: 29-31
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
7-7: Consider Compound Adjective Hyphenation.
In the description, consider changing “open source tool” to “open‑source tool” to clarify that “open‑source” functions as a compound adjective modifying “tool.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .../meet.google.com/gzd-hhbd-hpu) A free, open source tool for automated testing on real and ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
README.md(1 hunks)__templates__/create_driver.sh(1 hunks)docs/source/installation/python-package.md(4 hunks)packages/jumpstarter-driver-can/README.md(1 hunks)packages/jumpstarter-driver-corellium/README.md(1 hunks)packages/jumpstarter-driver-dutlink/README.md(1 hunks)packages/jumpstarter-driver-http/README.md(1 hunks)packages/jumpstarter-driver-network/README.md(1 hunks)packages/jumpstarter-driver-power/README.md(1 hunks)packages/jumpstarter-driver-probe-rs/README.md(1 hunks)packages/jumpstarter-driver-pyserial/README.md(1 hunks)packages/jumpstarter-driver-qemu/README.md(1 hunks)packages/jumpstarter-driver-raspberrypi/README.md(1 hunks)packages/jumpstarter-driver-shell/README.md(1 hunks)packages/jumpstarter-driver-snmp/README.md(2 hunks)packages/jumpstarter-driver-tftp/README.md(1 hunks)packages/jumpstarter-driver-yepkit/README.md(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (16)
- packages/jumpstarter-driver-power/README.md
- packages/jumpstarter-driver-network/README.md
- packages/jumpstarter-driver-shell/README.md
- packages/jumpstarter-driver-dutlink/README.md
- packages/jumpstarter-driver-yepkit/README.md
- packages/jumpstarter-driver-http/README.md
- packages/jumpstarter-driver-pyserial/README.md
- packages/jumpstarter-driver-corellium/README.md
- packages/jumpstarter-driver-can/README.md
- packages/jumpstarter-driver-qemu/README.md
- packages/jumpstarter-driver-probe-rs/README.md
- templates/create_driver.sh
- packages/jumpstarter-driver-tftp/README.md
- docs/source/installation/python-package.md
- packages/jumpstarter-driver-raspberrypi/README.md
- packages/jumpstarter-driver-snmp/README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .../meet.google.com/gzd-hhbd-hpu) A free, open source tool for automated testing on real and ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: e2e
🔇 Additional comments (8)
README.md (8)
3-5: New Community Badges Added.
The added badges for Matrix, Etherpad, and Community Meeting provide direct links to community channels and weekly gatherings. Their formatting and positioning are consistent with the updated project branding and documentation improvements.
11-16: Highlights Section Reformatted.
The bullet points clearly outline Jumpstarter’s key features. The revised texts such as “Unified Testing” and “CI/CD Ready” are concise and informative, enhancing clarity for new users.
22-24: Verify Installation Command forjumpstarter-all.
The installation command using the extra index URL appears correct and simplifies the setup process. Please verify that the URL (https://pkg.jumpstarter.dev/) remains current and accessible.
28-30: CLI Installation Command Looks Good.
The command for installing thejmpCLI tool is simple and follows the updated package index URL. No issues detected.
32-33: Service Installation Instructions Updated.
The instructions for installing the Jumpstarter Service now link to the consolidated domain and are clearly laid out for Kubernetes clusters. This helps ensure backward compatibility while guiding users to the new installation documentation.
38-38: Documentation Link Updated.
The documentation URL now correctly points to jumpstarter.dev, aligning with the domain consolidation. This change enhances consistency across the docs.
45-45: Contributing Section Revised.
The updated wording inviting contributors is friendly and concise. Linking directly to the contributing guide using a relative link improves clarity and navigability for new contributors.
49-49: License Section Formatting.
The license information is clearly presented with both a relative link to the LICENSE file and a direct external link to the Apache 2.0 License details. This dual-link approach ensures users can easily verify licensing terms.
Co-authored-by: Miguel Angel Ajo Pelayo <majopela@redhat.com>
|
@mangelajo lets give it a try with those emoji's even though i find them distracting. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
7-7: Consider Hyphenating "Open Source"The description reads "A free, open source tool..." which could be clearer as "A free, open‑source tool..." to correctly convey the compound adjective modifying "tool."
Suggested diff:- A free, open source tool for automated testing on real and virtual hardware with CI/CD integration. + A free, open‑source tool for automated testing on real and virtual hardware with CI/CD integration.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .../meet.google.com/gzd-hhbd-hpu) A free, open source tool for automated testing on real and ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .../meet.google.com/gzd-hhbd-hpu) A free, open source tool for automated testing on real and ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: pytest
- GitHub Check: e2e
🔇 Additional comments (8)
README.md (8)
3-5: New Community Badges AddedThe Matrix, Etherpad, and Community Meeting badges have been introduced to enhance community engagement and provide relevant direct links. Please verify that the URLs and badge styles align with the current branding and documentation guidelines.
11-13: Highlights Section UpdatedThe updated bullet points featuring emojis and bold headings create an engaging highlights section that succinctly summarizes key features. Ensure that the style remains consistent throughout the documentation.
23-25: Installation Command UpdatedThe command for installing all Jumpstarter Python components now uses the
pkg.jumpstarter.devendpoint, which simplifies the previous URL structure. Please confirm that this repository endpoint is current and reliable.
29-31: CLI Tool Installation Command UpdatedThe updated installation command for the
jmpCLI tool correctly references the new package repository. As with the previous command, verify the availability and security of the repository endpoint.
33-35: Service Installation Documentation LinkThe instructions for installing the Jumpstarter Service now directly refer to the new documentation URL. Please double-check that the link (https://jumpstarter.dev/installation/service/index.html) is live and that the documentation content is accurate.
39-39: Documentation Link UpdatedThe documentation link now correctly points to jumpstarter.dev, aligning with the website consolidation strategy. This update improves clarity and user navigation.
45-46: Contributing Section Call-to-ActionThe contributing section now delivers a concise and inviting call-to-action, encouraging new contributors to check out the contributing guide. The messaging is clear and sets the right tone.
50-50: License Section UpdatedThe license section has been refined to present both a relative link to the LICENSE file and the official Apache 2.0 URL. This dual reference ensures clarity and ease of access to licensing information.
mangelajo
left a comment
mangelajo
left a comment
There was a problem hiding this comment.
It looks good to me, I need to do the last step and move the domain, also create the pkgs domain.
3 participants
The goal of this PR is to consolide docs.jumpstarter.dev and jumpstarter.dev under jumpstarter.dev as links shown on jumpstarter.dev can easily be embedded into the documentation.
Once merged, for backward compatibility, docs.jumpstarter.dev should be redirected to jumpstarter.dev.
Summary by CodeRabbit
bashtoshellacross various documentation files for improved clarity.