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

feat: add docs page #399

Merged
merged 2 commits into from
Nov 5, 2024
Merged

feat: add docs page #399

merged 2 commits into from
Nov 5, 2024

Conversation

duyet
Copy link
Owner

@duyet duyet commented Nov 5, 2024

Summary by Sourcery

Add a new documentation page for ClickHouse Monitoring using Nextra and Next.js, and set up a GitHub Actions workflow to automate the build and deployment process to GitHub Pages.

New Features:

  • Introduce a new documentation page for ClickHouse Monitoring using Nextra and Next.js.

CI:

  • Add a GitHub Actions workflow to build and deploy the documentation to GitHub Pages.

Copy link
Contributor

sourcery-ai bot commented Nov 5, 2024

Reviewer's Guide by Sourcery

This PR adds a new documentation site using Nextra (a Next.js-based documentation framework) and sets up GitHub Actions workflow for building and deploying the docs to GitHub Pages. The implementation includes the basic Next.js configuration, theme setup, and GitHub Actions workflow for automated deployment.

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

File-Level Changes

Change Details Files
Set up GitHub Actions workflow for docs deployment
  • Configure workflow triggers for main branch pushes, pull requests, and manual dispatch
  • Set up GitHub Pages environment and permissions
  • Configure Node.js environment with yarn cache
  • Implement build and deployment steps using GitHub Pages actions
  • Add caching for Next.js build artifacts
.github/workflows/docs.yml
Initialize Nextra documentation framework
  • Configure Next.js with static export settings
  • Set up Nextra theme configuration
  • Add basic package dependencies
  • Create initial documentation page
docs/next.config.mjs
docs/theme.config.jsx
docs/package.json
docs/pages/_app.jsx
docs/pages/index.mdx

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

vercel bot commented Nov 5, 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 Nov 5, 2024 11:00am

@codecov-commenter
Copy link

codecov-commenter commented Nov 5, 2024

Bundle Report

Changes will increase total bundle size by 100 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
clickhouse-monitoring-bundle-server-cjs 2.37MB 34 bytes (0.0%) ⬆️
clickhouse-monitoring-bundle-edge-server-array-push 127.42kB 4 bytes (-0.0%) ⬇️
clickhouse-monitoring-bundle-client-array-push 3.57MB 70 bytes (0.0%) ⬆️

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 using Node.js LTS version (currently 20.x) instead of version 22 which is unstable/in development
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 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.

@codecov-commenter
Copy link

codecov-commenter commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.34%. Comparing base (4ac530c) to head (51f5e1d).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #399   +/-   ##
=======================================
  Coverage   78.34%   78.34%           
=======================================
  Files           5        5           
  Lines         157      157           
  Branches       58       57    -1     
=======================================
  Hits          123      123           
- Misses         31       34    +3     
+ Partials        3        0    -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@duyet duyet merged commit 9342b6a into main Nov 5, 2024
22 checks passed
@duyet duyet deleted the chore/update-update branch November 5, 2024 11:24
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.

2 participants