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

Fix docs broken logo and redirect from old URLs (Lombiq Technologies: OCORE-165) #15927

Merged
merged 5 commits into from
May 2, 2024

Conversation

Piedone
Copy link
Member

@Piedone Piedone commented Apr 30, 2024

I've broken the logo on the docs page in #15887, ironically, and fixing that here (didn't realize that docs_dir also affects the public URLs).

image

Also, due to the same thing, docs URLs including the /docs prefix were broken; I've added a redirect rule for that under https://readthedocs.org/dashboard/orchardcore/redirects/. So, all old links continue to work, but I've updated them in the repo.

This isn't how I wanted to do this, sorry about it.

Summary by CodeRabbit

  • Documentation Updates
    • Updated URLs across various documents and workflows to reflect the new structure of the Orchard Core documentation site.
    • Enhanced accessibility to guides, contribution pages, and module references by correcting and simplifying links.
  • Bug Fixes
    • Corrected outdated URLs in several markdown files and configuration scripts, ensuring users have access to the correct and current documentation resources.

Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Note

Reviews Paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

This summary outlines a series of updates made across various files in the Orchard Core project, primarily focusing on correcting and updating URLs in documentation references. The changes streamline access to the updated documentation paths, enhancing the accuracy and usability of links throughout the project's files, including markdown documents, configuration files, and code comments.

Changes

Files Affected Change Summary
.github/.../pull_request_template.md,
.github/.../first_time_contributor.yml,
CODE-OF-CONDUCT.md,
CONTRIBUTING.md,
README.md,
src/.../appsettings.json,
src/.../Options.cshtml,
src/.../Manifest.cs,
src/.../Constants.cs,
src/.../SqliteOptions.cs,
src/docs/topics/publishing-releases/README.md,
test/.../README.md
Updated URLs to reflect new documentation paths.
.github/.../assets_validation.yml Updated a URL in a PowerShell script message.
mkdocs.yml Paths for logo and favicon images updated from docs/assets/images/ to assets/images/.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 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.
  • 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
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.

Actionable comments posted: 3

Out of diff range and nitpick comments (1)
test/OrchardCore.Tests.Functional/cypress-commands/README.md (1)

Line range hint 58-61: Remove extra blank lines to maintain a clean and professional codebase.

- 
- 

CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Piedone and others added 2 commits May 1, 2024 00:09
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@Piedone
Copy link
Member Author

Piedone commented Apr 30, 2024

@coderabbitai stop

Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Tip

For best results, initiate chat on the files or code changes.

@Piedone, could you please clarify what you would like to stop or pause? Are you referring to pausing automated reviews, or is there something specific within the current review that you would like to address or halt?

@Piedone
Copy link
Member Author

Piedone commented Apr 30, 2024

@coderabbitai pause reviews

Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

@Piedone, I've paused the automated reviews as requested. If you need to resume them at any point, just let me know!

Actions performed

Reviews paused.

Co-authored-by: Hisham Bin Ateya <hishamco_2007@yahoo.com>
@Piedone Piedone merged commit 7be3a43 into OrchardCMS:main May 2, 2024
6 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.

None yet

2 participants