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 pre-release licensing details #236

Merged
merged 1 commit into from
Feb 21, 2025
Merged

Conversation

ljm42
Copy link
Member

@ljm42 ljm42 commented Feb 21, 2025

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • Documentation

    • Expanded the licensing FAQ with a new section on pre-release versions, detailing guidelines, feedback importance, and license requirements.
    • Enhanced text formatting for clarity.
  • New Features

    • Implemented a redirect for direct access to the pre-release FAQ, simplifying navigation for users.

Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Warning

Rate limit exceeded

@ljm42 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 75c19d4 and 466bb0c.

📒 Files selected for processing (2)
  • docs/unraid-os/faq/licensing-faq.md (3 hunks)
  • docusaurus.config.js (1 hunks)

Walkthrough

The changes update the Unraid OS licensing FAQ documentation by adding a new section titled "What happens with pre-releases," which outlines guidelines and license conditions for using pre-release software. Additionally, a new redirect has been configured in the Docusaurus configuration to automatically redirect requests from a specific pre-release FAQ URL to the updated section.

Changes

File(s) Change Summary
docs/unraid-os/faq/licensing-faq.md Added a new "What happens with pre-releases" section, removed trailing spaces, and reformatted existing sections for consistency.
docusaurus.config.js Added a new redirect entry from /go/faq-licensing-pre-release to /unraid-os/faq/licensing-faq/#what-happens-with-pre-releases in the plugins settings.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as Server (Docusaurus)
    U->>S: Request /go/faq-licensing-pre-release
    S->>U: Redirect to /unraid-os/faq/licensing-faq/#what-happens-with-pre-releases
    U->>S: Request /unraid-os/faq/licensing-faq/#what-happens-with-pre-releases
    S->>U: Serve updated licensing FAQ with new pre-release section
Loading

Possibly related PRs

  • Add go link for tailscale-docker #229: The changes in the main PR regarding the new redirect for pre-release software are related to the changes in this PR, which also involves adding a redirect in the docusaurus.config.js file, indicating a shared focus on enhancing redirect functionality within the documentation.

Suggested reviewers

  • elibosley
  • spencerjunraid

Poem

In the docs I hop with glee,
Formatting changes set free.
A new section now in sight,
Guiding pre-releases to the light.
With redirects hopping on the fly,
I celebrate with a joyful sigh!
🐇✨


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 your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-236.d1o5s833kbd339.amplifyapp.com

@ljm42 ljm42 force-pushed the add-prerelease-license-info branch from 75c19d4 to 466bb0c Compare February 21, 2025 17:57
@ljm42 ljm42 merged commit 4d596c9 into main Feb 21, 2025
3 checks passed
@ljm42 ljm42 deleted the add-prerelease-license-info branch February 21, 2025 22:36
@coderabbitai coderabbitai bot mentioned this pull request Mar 20, 2025
5 tasks
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