Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Add Open Graph Metadata for Link Previews#403

Merged
mangelajo merged 2 commits intomainfrom
og-meta
Apr 9, 2025
Merged

Add Open Graph Metadata for Link Previews#403
mangelajo merged 2 commits intomainfrom
og-meta

Conversation

@kirkbrauer
Copy link
Copy Markdown
Member

@kirkbrauer kirkbrauer commented Apr 8, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced social sharing with new metadata, including a clear title, description, and image for improved online previews.
    • Enabled greater flexibility in customizing page head content for documentation.
  • Documentation

    • Updated the documentation title to "Jumpstarter Docs" for clearer representation.
    • Introduced a dynamic deployment URL mechanism for improved documentation accessibility.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 8, 2025

Walkthrough

This pull request updates the documentation templates and configuration for Jumpstarter Docs. The changes add three new Open Graph meta tags to the head template, introduce an extrahead block in the page template that includes the head template, and update the Sphinx configuration to change the HTML title from "Jumpstarter" to "Jumpstarter Docs".

Changes

File(s) Change Summary
docs/source/_templates/head.html
docs/source/_templates/page.html
Added Open Graph meta tags in head.html and introduced a new block extrahead in page.html that includes head.html to allow flexible head section customization.
docs/source/conf.py Updated html_title from "Jumpstarter" to "Jumpstarter Docs" and added deploy_url to dynamically set the deployment URL for the documentation.

Sequence Diagram(s)

sequenceDiagram
    participant U as User/Doc Builder
    participant C as Sphinx Config (conf.py)
    participant P as page.html Template
    participant E as extrahead Block
    participant H as head.html Template

    U->>C: Read configuration (html_title)
    U->>P: Render page.html template
    P->>E: Invoke extrahead block
    E->>H: Include head.html (with Open Graph meta tags)
    H-->>E: Return meta tag elements
    E-->>P: Provide additional head elements
    P-->>U: Deliver rendered HTML page
Loading

Suggested reviewers

  • raballew

Poem

In a garden of code, I hop with glee,
Adding meta tags as sprightly as can be.
With extra head blocks and titles anew,
The docs now shine, fresh as morning dew.
Hoppy cheers from a rabbit so bright, 🐇
Keeping our codebase ever light!
Hop on, let’s code into the night!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d175d7f and c266a03.

📒 Files selected for processing (2)
  • docs/source/_templates/head.html (1 hunks)
  • docs/source/conf.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/source/_templates/head.html
  • docs/source/conf.py
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e
  • GitHub Check: pytest-matrix (3.11)
  • GitHub Check: pytest-matrix (3.13)
  • GitHub Check: pytest-matrix (3.12)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-utils Dockerfile.utils)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 8, 2025

Deploy Preview for jumpstarter-docs ready!

Name Link
🔨 Latest commit c266a03
🔍 Latest deploy log https://app.netlify.com/sites/jumpstarter-docs/deploys/67f5b56db93c1d0008186636
😎 Deploy Preview https://deploy-preview-403--jumpstarter-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kirkbrauer kirkbrauer requested a review from raballew April 8, 2025 23:50
@mangelajo mangelajo merged commit 12782ff into main Apr 9, 2025
18 checks passed
Copy link
Copy Markdown
Member

@raballew raballew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thats a great idea. The preview currently is broken. I would prefer a different description and page title.

@@ -0,0 +1,4 @@
<meta property="og:title" content="Jumpstarter Docs" />
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jumpstarter Documentation

Comment thread docs/source/conf.py

html_theme = "furo"
html_title = "Jumpstarter"
html_title = "Jumpstarter Docs"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jumpstarter Documentation

@@ -0,0 +1,4 @@
<meta property="og:title" content="Jumpstarter Docs" />
<meta property="og:description"
content="Jumpstarter is an open source and cloud native Hardware-in-the-Loop testing tool that enables you to test your software stack on both real hardware and virtual environments using CI/CD principles." />
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jumpstarter is a free, open-source tool for testing software on real/virtual hardware with CI/CD. It’s a Makefile for device automation—decouple targets, run consistent rules locally or distributed.

@coderabbitai coderabbitai Bot mentioned this pull request Apr 9, 2025
@NickCao NickCao deleted the og-meta branch April 30, 2025 18:29
@mangelajo mangelajo added this to the 0.6.0 milestone May 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants