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

Move repo #84 #85

Merged
merged 4 commits into from
Nov 21, 2024
Merged

Move repo #84 #85

merged 4 commits into from
Nov 21, 2024

Conversation

maehr
Copy link
Contributor

@maehr maehr commented Nov 8, 2024

Pull request

Proposed changes

Types of changes

  • New feature (non-breaking change which adds functionality).
  • Enhancement (non-breaking change which enhances functionality)
  • Bug Fix (non-breaking change which fixes an issue).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist

  • I have read the README document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have mentioned all co-authors in the PR description as Co-authored-by: Name <[email protected]>.

Summary by CodeRabbit

Release Notes

  • New Features

    • Updated repository links across various files to reflect the new project structure.
    • Enhanced the abstract description to clarify the repository's content.
  • Bug Fixes

    • Corrected links in the README and other documentation to ensure they point to the correct repository.
  • Documentation

    • Improved formatting and clarity in the about.qmd and index.qmd files, transitioning to Markdown for links and images.
  • Chores

    • Updated project metadata in package.json to reflect the new project name and description.

Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Walkthrough

The pull request includes updates across multiple files to change references from the old repository URL (digihistch24/book-of-abstracts) to the new URL (digihistch24/digihistch24.github.io). Key modifications include updates to links in the .github/ISSUE_TEMPLATE/config.yml, CHANGELOG.md, CITATION.cff, README.md, _quarto.yml, and others. The changes also involve minor formatting adjustments and clarifications in the content, particularly in the about.qmd and index.qmd files, without altering the overall functionality.

Changes

File Change Summary
.github/ISSUE_TEMPLATE/config.yml Updated discussion link from book-of-abstracts to digihistch24.github.io.
CHANGELOG.md Changed link in "Unreleased" section from book-of-abstracts to digihistch24.github.io.
CITATION.cff Shortened title and updated repository URLs, including an expanded abstract description.
README.md Updated all repository links from book-of-abstracts to digihistch24.github.io.
_quarto.yml Modified site-url, repo-url, and issue-url to reflect the new repository structure.
about.qmd Updated description and formatting for better clarity; escaped email address to prevent auto-linking.
cliff.toml Updated "Unreleased" section URL from book-of-abstracts to digihistch24.github.io.
conference-program.qmd Minor formatting adjustments in conference details.
custom-header.html Changed data-domain attribute in <script> tag to reflect new domain.
index.qmd Converted HTML links and images to Markdown format for consistency.
package.json Updated project name, description, and url fields to reflect new context and repository.

Assessment against linked issues

Objective Addressed Explanation
Move https://digihistch24.github.io/book-of-abstracts/ to https://digihistch24.github.io (#83)

Possibly related PRs

Suggested labels

submission

Suggested reviewers

  • mtwente

Poem

In the meadow where changes bloom,
We’ve shifted our site to make more room.
From abstracts to history, a new URL,
With links that now flow, oh, how they swell!
Hopping along, we celebrate bright,
Digital tales take their flight! 🐇✨


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

@maehr maehr requested a review from mtwente November 8, 2024 09:44
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: 1

🧹 Outside diff range and nitpick comments (1)
_quarto.yml (1)

25-27: Consider adding an aria-label for better accessibility.

The GitHub link update is correct, but consider enhancing accessibility.

Consider adding an aria-label:

  - icon: github
    url: https://github.com/digihistch24/digihistch24.github.io/
    target: _blank
+   aria-label: "Visit our GitHub repository"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3be8f7e and 8965429.

📒 Files selected for processing (11)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • CHANGELOG.md (1 hunks)
  • CITATION.cff (2 hunks)
  • README.md (3 hunks)
  • _quarto.yml (2 hunks)
  • about.qmd (2 hunks)
  • cliff.toml (1 hunks)
  • conference-program.qmd (2 hunks)
  • custom-header.html (1 hunks)
  • index.qmd (1 hunks)
  • package.json (1 hunks)
✅ Files skipped from review due to trivial changes (8)
  • .github/ISSUE_TEMPLATE/config.yml
  • CHANGELOG.md
  • README.md
  • about.qmd
  • cliff.toml
  • conference-program.qmd
  • custom-header.html
  • package.json
🔇 Additional comments (8)
CITATION.cff (2)

35-36: LGTM! Repository URLs updated correctly.

The repository and website URLs have been properly updated to reflect the new location, aligning with the PR objective of moving from /book-of-abstracts/ to the root path.


38-38: LGTM! Abstract updated to reflect full scope.

The abstract now accurately describes the repository contents by including both the website and Book of Abstracts.

_quarto.yml (3)

10-11: LGTM! Repository URLs are correctly updated.

The repository and issue URLs are properly updated to reflect the new repository location.


Line range hint 93-93: Verify if freeze: false is intended for production.

The freeze: false setting allows Quarto to regenerate all files on each build. For production deployments, consider setting this to true to improve build performance and ensure consistent outputs.

Please confirm if this setting is intentional for the production deployment.


9-9: LGTM! Site URL update matches requirements.

The site-url change from /book-of-abstracts/ to root is correct and aligns with the PR objectives.

Let's verify no old paths remain in the content files:

index.qmd (3)

16-16: LGTM! Well-formatted external link.

The external link is properly formatted with appropriate security attributes.


18-18: Verify the image path in the new structure.

The image path /images/logo_digital_history_network_ch.svg needs verification to ensure it will be accessible after moving to the root path.

✅ Verification successful

Image path is correctly structured and accessible

The image file exists at the expected location /images/logo_digital_history_network_ch.svg and is referenced consistently across the codebase. The path is already relative to the root, making it compatible with the current structure.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and location of the logo image
# Check if the image exists in the images directory
fd -e svg "logo_digital_history_network_ch" 

# Look for any references to this image in the codebase
rg "logo_digital_history_network_ch\.svg"

Length of output: 453


10-10: Verify the new path for Book of Abstracts.

The link /book-of-abstracts.html needs verification as it differs from both the old path (/book-of-abstracts/) and the new root path (/) mentioned in the PR objectives.

✅ Verification successful

Let me try another search strategy to verify the path situation.


The link to Book of Abstracts is correct and matches the site structure

The verification shows that:

  • A book-of-abstracts.qmd file exists in the root directory
  • The site configuration in _quarto.yml explicitly defines the Book of Abstracts link as book-of-abstracts.qmd in the navbar
  • Quarto will automatically convert .qmd to .html during site generation

Therefore, the link /book-of-abstracts.html in the index page is correct and aligns with the site's structure.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if book-of-abstracts.html exists or is planned to exist
# Look for any references to this file in the codebase
rg "book-of-abstracts\.html"

# Check if there's a file that might serve as the new landing page
fd -e html "book-of-abstracts"

Length of output: 453


Script:

#!/bin/bash
# Check for any Quarto/HTML files related to book of abstracts
fd "book.*(abstracts|abstract)" -e qmd -e html

# Look for any references to book of abstracts in Quarto files
rg -t md -t qmd "book.*(abstracts|abstract)"

# Check if there's a _quarto.yml that might define output settings
fd "_quarto.yml" && cat $(fd "_quarto.yml")

Length of output: 8318

CITATION.cff Show resolved Hide resolved
@mtwente mtwente merged commit 567db51 into digihistch24:main Nov 21, 2024
3 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.

Move https://digihistch24.github.io/book-of-abstracts/ to https://digihistch24.github.io
2 participants