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 Navigating Dependency Chaos with Lockfiles blog post #30

Merged
merged 16 commits into from
Feb 28, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Feb 26, 2024

This PR adds a blog post titled "Navigating Dependency Chaos with Lockfiles" covering dependency management topics and specifically focusing on lockfiles to help explain their purpose.

Thank you in advance for any thoughts or feedback you may have! Please don't hesitate to let me know if you have any questions.

Copy link

netlify bot commented Feb 26, 2024

Deploy Preview for set-website ready!

Name Link
🔨 Latest commit ab5b187
🔍 Latest deploy log https://app.netlify.com/sites/set-website/deploys/65df9414041b2f0008195748
😎 Deploy Preview https://deploy-preview-30--set-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Feb 26, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-02-28 20:17 UTC

Copy link

@vincerubinetti vincerubinetti left a comment

Choose a reason for hiding this comment

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

Very nicely written article. I left some comments, but all are completely optional.

Copy link

@falquaddoomi falquaddoomi left a comment

Choose a reason for hiding this comment

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

Nice work, and a good introduction to a complicated and important topic. I made a few comments, but IMO if you want to publish this as-is I think it's good.

Comment on lines 85 to 101
```mermaid!
mindmap
root((Project))
Data storage
File 1
Database 2
Data x processing
Package X
Package Y
Integration
Solution A
Platform B

```

_Dependency awareness and opportunity can be grouped into concerns and documented as part of a literature review (seen here as a [mind map](https://en.wikipedia.org/wiki/Mind_map))._
{:.center}

Choose a reason for hiding this comment

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

Not sure if this is actually broken, but I see a "broken image" icon when I view this post in the Netlify preview, just FYI.

Copy link
Member Author

Choose a reason for hiding this comment

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

Dang, you're right, it appears the same for me. Instinct here has me thinking this might have something to do with Mermaid versions, but not sure. I'll adjust this to get it displayed correctly.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed with a dynamic reference to Mermaid 10.

Choose a reason for hiding this comment

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

Awesome, looks like that worked; it's showing up fine in the Netlify preview for me now, at least. Kudos!

Copy link
Member Author

Choose a reason for hiding this comment

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

This is fixed for the post but we may want to raise this with Jekyll Spaceship or elsewhere depending on what might be happening. I'm pretty sure it's a Mermaid version reference that makes this happen (mindmaps were I believe experimental or non-existent at one point). @vincerubinetti would you have any recommendations on this front?

Choose a reason for hiding this comment

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

Perhaps it's worth raising an issue, though the jekyll-spaceship repo seems to have been inactive since 2022. Looking through the repo a bit, it looks like it just uses "https://mermaid.ink/svg/" as a conversion service (I think you brought this up before?). And according to that service, it has already been using Mermaid 10 for a while. Mermaid itself says that a mindmap is experimental and doesn't seem to mention which version it came to, so maybe it's extremely recent and mermaid.ink is a little behind? Either way, it seems more like an issue with mermaid.ink or mermaid itself.

Also, appropriate that you'd run into a versioning issue on this blog post.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks @vincerubinetti ! And agreed on the versioning issue within the context of this post 😆 - fitting ! Maybe we need a lockfile update somewhere? 🙂

I tried to create a mermaid.ink mindmap and it worked alright (link here). I'll give this a further investigation with a Jekyll-spaceship test when there's a moment.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've recreated the challenge outside of lab-website-template and just opened an issue on this topic here: jeffreytse/jekyll-spaceship#96

@d33bs
Copy link
Member Author

d33bs commented Feb 28, 2024

Thank you @vincerubinetti and @falquaddoomi for the reviews and comments! I've addressed these with further commits and will now merge this in.

@d33bs d33bs merged commit b44f799 into CU-DBMI:main Feb 28, 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.

3 participants