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
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
ddd9645
Add 0.3 upgrade guide
ThetaSinner Jun 17, 2024
a8c39bb
Update src/pages/get-started/upgrade-holochain-0.3.md
ThetaSinner Jun 18, 2024
52c28a5
Update src/pages/get-started/upgrade-holochain-0.3.md
ThetaSinner Jun 18, 2024
f633ba0
Review changes
ThetaSinner Jun 18, 2024
a6b6483
Add main page tile
ThetaSinner Jun 18, 2024
ac01fb0
Fix links
ThetaSinner Jun 18, 2024
92059d4
Fix link for previous guide
ThetaSinner Jun 18, 2024
912ec27
Relative links not helpful
ThetaSinner Jun 18, 2024
d530809
apply formatting fixes to 0.2 upgrade guide
pdaoust Jun 18, 2024
4644065
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
6e0848f
Apply suggestions from code review
ThetaSinner Jun 19, 2024
20eff30
Apply suggestions from code review
ThetaSinner Jun 19, 2024
7a6520c
Add redirect
ThetaSinner Jun 19, 2024
e6ce4f9
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
adf8820
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
1484825
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
771f75c
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
c17b825
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
28dc3a9
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
922a963
Update src/pages/upgrade/upgrade-holochain-0.3.md
ThetaSinner Jun 19, 2024
689a921
Fix whitespace
ThetaSinner Jun 19, 2024
3ba29e5
Merge branch 'add-0.3-upgrade-guide' of github.com:holochain/docs-pag…
pdaoust Jun 21, 2024
b853d0d
markdown formatting fixes
pdaoust Jun 21, 2024
bdcfe7f
some work on information architecture / nav
pdaoust Jun 21, 2024
ee0c50d
fix over-eager header promoting regex friendly fire
pdaoust Jun 24, 2024
4805b9c
remove upgrade guide from home page
pdaoust Jun 24, 2024
23cdd31
Merge pull request #456 from holochain/add-0.3-upgrade-guide-paul-edits
pdaoust Jun 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,16 @@
to = "/get-started/"
status = 301

# This comment does absolutely nothing and can be deleted.
Copy link
Contributor 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!

# The first upgrade guide lived under getting started. It has been moved to its own area.
[[redirects]]
from = "/get-started/upgrade-holochain/"
to = "/resources/upgrade/upgrade-holochain-0.2/"
status = 301

# Every time there's a new breaking release that achieves 'recommended' status,
# update this temporary redirect. /resources/upgrade/latest/ isn't in the site nav,
# but it is a handy URL we can hand out without needing to look up what the proper URL is.
[[redirects]]
from = "/resources/upgrade/latest/"
to = "resources/upgrade/upgrade-holochain-0.2/"
status = 302
2 changes: 1 addition & 1 deletion src/pages/_data/navigation/mainNav.json5
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
{ 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: "Setup For a Local Event", url: "/get-started/at-an-event/" },
]
},
Expand All @@ -32,6 +31,7 @@
]
},
{ title: "Resources", url: "/resources/", children: [
{ title: "Upgrade Guides", url: "/resources/upgrade/" },
{ title: "HDK", url: "https://docs.rs/hdk", external: true },
{ title: "HDI", url: "https://docs.rs/hdi", external: true },
{ title: "App API", url: "https://docs.rs/holochain_conductor_api/latest/holochain_conductor_api/enum.AppRequest.html", external: true },
Expand Down
4 changes: 4 additions & 0 deletions src/pages/resources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ tocData:
href: tutorials-and-training
---

## Upgrade guides

If you're upgrading your hApp to a newer version of Holochain, we have some [upgrade guides](/resources/upgrade/) to make your work easier.

## HDK and HDI

When you write a Holochain application, the part that lives in Holochain is called a [DNA](/concepts/2_application_architecture/#layers-of-the-application-stack). It runs as a guest in a WebAssembly sandbox and talks to the host, or Holochain conductor, through the host API. It's also expected to implement callbacks that the conductor needs to call at certain times. The HDK and HDI Rust crates make it easy for you write guest code that interfaces with the conductor --- the HDK for your DNA's [coordinator zomes](/resources/glossary/#coordinator-zome) and the HDI for [integrity zomes](/resources/glossary/#integrity-zome).
Expand Down
12 changes: 12 additions & 0 deletions src/pages/resources/upgrade/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Upgrade Guides
hide:
- toc
---

### Upgrade Guides

Upgrading between versions of Holochain can be a bit tricky! While Holochain is in beta, you can expect breaking changes between minor versions. To make upgrading your hApp easier, we create guides to help you move from one Holochain version to the next.

* [Holochain Upgrade 0.1 → 0.2](/resources/upgrade/upgrade-holochain-0.2/)
* [Holochain Upgrade 0.2 → 0.3](/resources/upgrade/upgrade-holochain-0.3/)
Loading