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 0.3 upgrade guide #454

Merged
merged 27 commits into from
Jun 24, 2024
Merged

Add 0.3 upgrade guide #454

merged 27 commits into from
Jun 24, 2024

Conversation

ThetaSinner
Copy link
Member

No description provided.

@@ -8,7 +8,8 @@
{ title: "Dev Tools Setup Tips", url: "/get-started/install-advanced/" },
{ title: "Setup Without Nix", url: "/get-started/install-without-nix/" },
{ title: "Distribute your App", url: "/get-started/distribute-your-app/" },
{ title: "Holochain Upgrade 0.1 → 0.2", url: "/get-started/upgrade-holochain/" },
{ title: "Holochain Upgrade 0.1 → 0.2", url: "/get-started/upgrade-holochain-0.2/" },
Copy link
Member Author

Choose a reason for hiding this comment

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

Is it okay to rename these? It will break existing links but it'd be nice to have a pattern for these file names going forward. If we do want to maintain links then maybe we could always have the link with no version suffix go to the latest guide?

Copy link
Collaborator

@pdaoust pdaoust Jun 18, 2024

Choose a reason for hiding this comment

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

yup, totally a good idea. The only caveat is that we should always add a 301 redirect to /netlify.toml when we do this, for search results and bookmarks.

[edit] read your whole comment, and I like the idea of having a URL that just 302 redirects to the latest guide too.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added the 301. The 302 I changed my mind about, because we now have a top level page that lists all the version migration guides so there's an easy place to send people to look for the right guide

src/pages/get-started/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
@ThetaSinner ThetaSinner requested review from pdaoust, matthme, c12i and a team June 17, 2024 18:13
Copy link
Contributor

@matthme matthme left a comment

Choose a reason for hiding this comment

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

Looking great! The only thing I'm wondering is whether this valuable guide deserves a more obvious link, potentially even somewhere on the main page of the dev portal.

Copy link

@c12i c12i left a comment

Choose a reason for hiding this comment

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

Looks good to me


!!! note
This takes all updates from Holonix, possibly including an update to the Rust version that Holonix is currently using.
You should run this command whenever you update your Cargo dependencies to the latest HDI/HDK versions.
Copy link
Contributor

Choose a reason for hiding this comment

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

What I do in cargo.tomls has no effect on the flake or its lock. This suggests to run nix flake update every time I update HDI/HDK. What's the reason for that?

Copy link
Member Author

Choose a reason for hiding this comment

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

They're not directly related but the Nix updates should be done at least as frequently. I'll reword this to make it clearer what I'm getting at

src/pages/get-started/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/get-started/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
@ThetaSinner
Copy link
Member Author

The only thing I'm wondering is whether this valuable guide deserves a more obvious link, potentially even somewhere on the main page of the dev portal.

I always think of getting started as the main page because I tend to go there ->

image

But that's a good point, I wonder where else it might be good to put this

@matthme
Copy link
Contributor

matthme commented Jun 18, 2024

I did not necessarily mean to remove it from there but to add an additional link to it somewhere else where it's more obvious. Like on the main page something along the lines of (once 0.3 is marked as the recommended version): "Holochain 0.3 is now the recommended version. If you've been using 0.2 here is a guide on how to upgrade your happ from 0.2 to 0.3".

@ThetaSinner
Copy link
Member Author

Agreed, I think it makes sense to keep it in the getting started guide because people may well see it there and remember it exists to come back later. I am working on adding a tile to the front page and we can see how that looks

@ThetaSinner
Copy link
Member Author

@matthme How does that look? The only minor issue is that I've re-used an icon which looks a bit off on the main page. I'm not sure where those are sourced from because they're embedded through the SCSS for the site.

@matthme
Copy link
Contributor

matthme commented Jun 18, 2024

Looks great 👍

@ThetaSinner
Copy link
Member Author

Super, thank you! :)

Copy link
Collaborator

@pdaoust pdaoust left a comment

Choose a reason for hiding this comment

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

Did a formatting/grammar/etc sweep; mostly tiny changes. There are a few questions in there though. I'm also going to follow up with a PR on your PR to get the IA sorted out -- I want to avoid creating another category; maybe I'll put it under Resources.

src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
src/pages/upgrade/upgrade-holochain-0.3.md Outdated Show resolved Hide resolved
@@ -130,4 +130,8 @@
to = "/get-started/"
status = 301

# This comment does absolutely nothing and can be deleted.
Copy link
Member Author

Choose a reason for hiding this comment

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

Okay then :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

ha ha, I think I was probably trying to force a CI run or bust a cache or something!

@ThetaSinner
Copy link
Member Author

Github has got a bit confused about whitespace changes but I think I've resolved all the comments now

@pdaoust
Copy link
Collaborator

pdaoust commented Jun 21, 2024

I've added my final review in #456. Please review and merge @ThetaSinner , and it'll go into this branch, and then you can merge this one into main without waiting for me to approve it.

@ThetaSinner ThetaSinner dismissed pdaoust’s stale review June 24, 2024 19:46

PR with fixes merged into this one, see comment above for approval to proceed with merge

@ThetaSinner ThetaSinner merged commit 38d03bf into main Jun 24, 2024
6 checks passed
@ThetaSinner ThetaSinner deleted the add-0.3-upgrade-guide branch June 24, 2024 19:46
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.

5 participants