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

Refactor remove portfolio #404

Merged
merged 3 commits into from
Mar 14, 2024
Merged

Refactor remove portfolio #404

merged 3 commits into from
Mar 14, 2024

Conversation

jsolly
Copy link
Owner

@jsolly jsolly commented Mar 14, 2024

Description

Remove portfolio page (migrated to JohnSolly.dev)

Changes Made

  • Added new feature
  • Fixed bug
  • Refactored code
  • Other (please describe):

Test Plan

All tests pass. Removed Portfolio-related tests.

Screenshots (if appropriate)

Checklist

  • I have read the contributing guidelines
  • I have added tests to cover my changes and they all pass in addition to the existing tests.
  • I have added documentation for my changes (if appropriate)

Additional Information

Summary by CodeRabbit

  • New Features
    • Added a new list item in the "About Me" section across various parts of the site.
  • Enhancements
    • Updated portfolio links to open in a new tab with a new URL.
    • Modified the Mastodon link in the "About Me" section of blog posts.
  • Bug Fixes
    • Allowed all categories to be shown in the sidebar by removing conditional checks.
  • Chores
    • Removed the "Portfolio" page and all its references across the site, including sitemaps, URLs, views, and tests.
    • Updated footer, header, and sidebar links for the portfolio to reflect the new URL.
  • Documentation
    • Removed mention of the "Portfolio page with testimonials" from the README.

John Solly added 2 commits March 13, 2024 21:59
Copy link

coderabbitai bot commented Mar 14, 2024

Walkthrough

The project underwent a significant restructuring, primarily involving the removal of the portfolio feature across various components. This included eliminating site maps, URLs, views, and references to the portfolio in templates and tests. Additionally, some updates were made to links in the blog's templates, enhancing navigation and user experience.

Changes

File Path Change Summary
README.md Removed mention of "Portfolio page with testimonials, contact me, Web vitals, and more!" feature.
app/.../sitemaps.py Removed PortfolioSiteMap class and methods.
app/app/urls.py Removed PortfolioSiteMap from exported entities.
app/blog/context_processors.py Removed "Portfolio" breadcrumb logic.
app/blog/templates/... Updated links and removed portfolio references in various templates.
app/blog/urls.py, app/blog/views.py Removed PortfolioView affecting routing and view logic.
app/tests/... Removed tests related to portfolio features.

🐇✨

Once upon a codebase, wide and vast,
A rabbit hopped, making changes fast.
"Away with portfolios, let's make it neat,
Update the links, make the experience sweet."
With every hop and every tweak,
The project shone, unique and sleek.
🌟🐾

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@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 a947fc1 and 864249d.
Files ignored due to path filters (11)
  • app/staticfiles/portfolio/AmyBrazil.png is excluded by: !**/*.png
  • app/staticfiles/portfolio/CraigUtley.png is excluded by: !**/*.png
  • app/staticfiles/portfolio/GeoAsteroids_playthrough.mp4 is excluded by: !**/*.mp4
  • app/staticfiles/portfolio/John-Solly-Resume.pdf is excluded by: !**/*.pdf
  • app/staticfiles/portfolio/KathrynThorpe.png is excluded by: !**/*.png
  • app/staticfiles/portfolio/MeredithBean.png is excluded by: !**/*.png
  • app/staticfiles/portfolio/NathanGoddard.png is excluded by: !**/*.png
  • app/staticfiles/portfolio/gisLecture.jpeg is excluded by: !**/*.jpeg
  • app/staticfiles/portfolio/lighthouse_scores.svg is excluded by: !**/*.svg
  • app/staticfiles/portfolio/resume-2023-08-02.zip is excluded by: !**/*.zip
  • app/staticfiles/svg/accordion_arrow.svg is excluded by: !**/*.svg
Files selected for processing (16)
  • README.md (2 hunks)
  • app/app/sitemaps.py (1 hunks)
  • app/app/urls.py (2 hunks)
  • app/blog/context_processors.py (1 hunks)
  • app/blog/templates/blog/parts/about_me.html (2 hunks)
  • app/blog/templates/blog/parts/about_me_post_detail.html (2 hunks)
  • app/blog/templates/blog/parts/footer.html (1 hunks)
  • app/blog/templates/blog/parts/header.html (1 hunks)
  • app/blog/templates/blog/parts/sidebar.html (1 hunks)
  • app/blog/templates/blog/works_cited.html (1 hunks)
  • app/blog/urls.py (2 hunks)
  • app/blog/views.py (1 hunks)
  • app/tests/test_context_processors.py (1 hunks)
  • app/tests/test_sitemaps.py (2 hunks)
  • app/tests/test_urls.py (2 hunks)
  • app/tests/test_views.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • app/tests/test_views.py
Additional comments: 8
app/blog/templates/blog/parts/footer.html (1)
  • 17-17: The update to the "Portfolio" link in the footer is correctly implemented, aligning with the PR objectives and following best practices for external links.
app/tests/test_sitemaps.py (1)
  • 8-13: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-36]

The removal of tests related to the PortfolioSiteMap is consistent with the PR objectives, ensuring the test suite remains relevant to the project's current scope.

app/blog/urls.py (1)
  • 13-18: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-37]

The removal of PortfolioView from the routing is consistent with the PR objectives and does not introduce any routing issues.

app/app/urls.py (1)
  • 9-14: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [6-17]

The removal of PortfolioSiteMap from the sitemaps dictionary aligns with the PR's objective. Ensure that all references to PortfolioSiteMap have been removed throughout the project to avoid any broken links or orphaned references.

app/tests/test_context_processors.py (1)
  • 65-70: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of the test_portfolio_breadcrumb function aligns with the PR's objective. Ensure that the test suite remains comprehensive and covers all necessary features after the removal of portfolio-related tests.

app/blog/templates/blog/parts/header.html (1)
  • 24-24: The update to the 'Portfolio' link to open in a new tab with the URL 'https://johnsolly.dev' aligns with the PR's objective and improves user experience by clearly directing users to the new portfolio location.
app/tests/test_urls.py (1)
  • 14-19: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of PortfolioView and its corresponding URL test aligns with the PR's objective. Ensure that the URL testing coverage remains comprehensive and covers all necessary features after the removal of portfolio-related tests.

README.md (1)
  • 164-164: The removal of the "Portfolio page with testimonials, contact me, Web vitals, and more!" feature from the README aligns with the PR's objective and helps clarify the current scope of the project. However, please address the following typographical and grammatical issues to improve the README's readability and professionalism:
  • Consider correcting possible spelling mistakes (e.g., "Awesome Django Blog", "Formating" should be "Formatting").
  • Ensure consistent use of punctuation and capitalization throughout the document.

Copy link

@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 864249d and 683d19f.
Files selected for processing (1)
  • README.md (2 hunks)
Additional comments: 2
README.md (2)
  • 164-164: The removal of the portfolio page feature is correctly documented under the "Depreciated Features" section. This change aligns with the PR's objective to streamline the project's focus. However, it's important to ensure that all external links and references to the portfolio page are updated or removed across the project to maintain consistency.
  • 161-167: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-193]

While reviewing the README.md file, several potential typographical and grammatical issues were flagged by static analysis tools. However, upon closer inspection, most of these appear to be false positives related to technical terms, code snippets, or intentional stylistic choices. It's crucial to maintain technical accuracy and consistency in documentation, so no changes are recommended based on these hints.

@jsolly jsolly merged commit 0c5f8e5 into master Mar 14, 2024
2 checks passed
@jsolly jsolly deleted the refactor-remove-portfolio branch March 14, 2024 14:37
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