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

add gstreamer error documentation #3134

Merged
merged 3 commits into from
Dec 16, 2023

Conversation

mkwsnyder
Copy link
Contributor

@mkwsnyder mkwsnyder commented Dec 15, 2023

Description

Adds documentation for a solution to a common GStreamer error on some Linux distros as discussed on this Discord thread.

Note: I know the versioned_docs will be deprecated, but I went and added this note there as well.

Type of change

  • Documentation

Summary by CodeRabbit

  • Documentation
    • Added guidance for resolving GStreamer error on Linux when using <Audio> or <Video> elements.
    • Provided installation instructions for gst-plugins-good across various Linux distributions.
    • Included notes on the issue's impact on Tauri apps and its relation to WebkitGTK.

Copy link
Contributor

coderabbitai bot commented Dec 15, 2023

Walkthrough

A new section addressing a GStreamer error when using <Audio> or <Video> elements on Linux has been added to the project documentation. This update includes installation instructions for gst-plugins-good on various Linux distributions and additional notes about the issue's impact on Tauri apps and its association with WebkitGTK.

Changes

File Path Change Summary
.../docs/guides/linux.mdx
.../versioned_docs/version-v2.6.0/guides/linux.mdx
.../versioned_docs/version-v2.7.0/guides/linux.mdx
Added troubleshooting instructions for a GStreamer error on Linux, including package installation and notes on the impact for Tauri apps and WebkitGTK.
.../src/pages/changelog.mdx Updated the unidiff snippet to exclude changes related to exported or public entities and primarily include additions related to project documentation and feature updates.

🐇✨
In docs of Linux and Tauri, a fix has sprung,
For <Audio> and <Video>, the solution's now sung.
gst-plugins-good will make the streams flow,
So your apps and elements can put on a show. 🎶🖥️

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between dc5f0b6 and 9fdfb82.
Files selected for processing (3)
  • website/docs/guides/linux.mdx (1 hunks)
  • website/versioned_docs/version-v2.6.0/guides/linux.mdx (1 hunks)
  • website/versioned_docs/version-v2.7.0/guides/linux.mdx (1 hunks)
Files skipped from review due to trivial changes (1)
  • website/versioned_docs/version-v2.6.0/guides/linux.mdx
Additional comments: 4
website/docs/guides/linux.mdx (1)
  • 22-72: The documentation update is comprehensive and well-structured. It provides clear instructions for installing gst-plugins-good across different Linux distributions, which should help users resolve the GStreamer error. The use of tabs to separate commands for different distributions enhances readability and user experience. The additional context and source attribution are also beneficial for users seeking more information. This update should be a valuable addition to the Linux guide.
website/versioned_docs/version-v2.7.0/guides/linux.mdx (3)
  • 34-61: Verify if mdx-code-block is a custom component or a typo. If it's a typo, it should be replaced with the correct Markdown syntax for code blocks.

  • 64-64: Ensure that the link to the GStreamer installation page is correct and functional.

  • 68-70: The additional notes provide context about the issue, which is helpful for users. However, ensure that the links to the WebkitGTK bug report and the Arch-based systems wiki are correct and accessible.

@leaanthony
Copy link
Member

This is amazing 😍 Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9fdfb82 and ed8ed78.
Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
Files skipped from review due to trivial changes (1)
  • website/src/pages/changelog.mdx

@mkwsnyder
Copy link
Contributor Author

Changelog updated. o7

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ed8ed78 and 107c1ca.
Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
Files skipped from review due to trivial changes (1)
  • website/src/pages/changelog.mdx

@leaanthony leaanthony merged commit 1683e24 into wailsapp:master Dec 16, 2023
10 checks passed
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