Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): add jitsu #438

Merged
merged 1 commit into from
Dec 3, 2024
Merged

chore(docs): add jitsu #438

merged 1 commit into from
Dec 3, 2024

Conversation

duyet
Copy link
Owner

@duyet duyet commented Dec 3, 2024

Summary by Sourcery

Documentation:

  • Add Jitsu script to the documentation theme configuration.

Copy link

vercel bot commented Dec 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clickhouse-monitoring ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 3, 2024 6:32pm

Copy link
Contributor

sourcery-ai bot commented Dec 3, 2024

Reviewer's Guide by Sourcery

The PR adds Jitsu analytics script alongside the existing Seline analytics in the documentation theme configuration. The implementation wraps both script tags in a React fragment to properly handle multiple elements in the head configuration.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added Jitsu analytics script and restructured head configuration
  • Wrapped existing Seline script in React fragment (<>)
  • Added new Jitsu analytics script
  • Maintained async loading for both scripts
docs/theme.config.jsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @duyet - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief comment in the config file or PR description about the purpose of adding Jitsu analytics alongside Seline.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +9 to +13
<>
<Script
async
src="https://cdn.seline.so/seline.js"
data-token="05046b3773d0534"
Copy link
Contributor

Choose a reason for hiding this comment

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

🚨 suggestion (security): Consider adding Subresource Integrity (SRI) checks for the external scripts

To prevent potential security issues from CDN compromises, add integrity attributes with appropriate hash values for both script tags.

<Script
  async
  src="https://cdn.seline.so/seline.js"
  data-token="05046b3773d0534"
  integrity="sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
  crossOrigin="anonymous"
/>

@duyet duyet merged commit 0548b3a into main Dec 3, 2024
41 checks passed
@duyet duyet deleted the chore/jitsu branch December 3, 2024 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant