-
Notifications
You must be signed in to change notification settings - Fork 28
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
Conversation
@@ -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/" }, |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this 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.
There was a problem hiding this 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
Co-authored-by: Jost Schulte <[email protected]>
Co-authored-by: Jost Schulte <[email protected]>
I always think of getting started as the main page because I tend to go there -> But that's a good point, I wonder where else it might be good to put this |
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". |
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 |
@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. |
Looks great 👍 |
Super, thank you! :) |
There was a problem hiding this 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.
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
@@ -130,4 +130,8 @@ | |||
to = "/get-started/" | |||
status = 301 | |||
|
|||
# This comment does absolutely nothing and can be deleted. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay then :)
There was a problem hiding this comment.
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!
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
Co-authored-by: Paul d'Aoust <[email protected]>
Github has got a bit confused about whitespace changes but I think I've resolved all the comments now |
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 |
Co-authored-by: ThetaSinner <[email protected]>
Paul's edits to 0.3 upgrade guide
PR with fixes merged into this one, see comment above for approval to proceed with merge
No description provided.