Skip to content

Commit

Permalink
Add Migration guides to v1.0.0 (#51)
Browse files Browse the repository at this point in the history
* begin migration guide v1.0

* Add Plugin loading section

* Add note Plugin Loading

* Rewrite Pull Subscribers, Add Timestamps

* Add Python Migration Guide

* H2 standard, Reworded Encoding section

* Elaborate ZBytes

* add Attachment and Query & Queryable sections, document formatting

* formatting

* Elaborate PullSubscriber -> RingChannel Changes

* add scouting secion to config changes

* add Handler Section rust, formatting changes

* add CPP, cleanup

* Add Zenoh-Pico, Fix Right Nav Bar, Simplified naming of guides

* Mention attachment, minor rewrite Encoding, explain reply, RingChannel similar, explain timestamps, separate plugin into own section.

* Apply suggestions from @J-Loudet code review

Co-authored-by: J-Loudet <julien.loudet@zettascale.tech>

* remove aside, add link to type-layout rust-doc, elaborate on Queryable Handler

* Update content/docs/migration_1.0/Python.md

Co-authored-by: Joseph Perez <joperez@hotmail.fr>

* Add Zenoh-C with small corrections

* use one guide for C+Pico

* Update Config Changes to plugin loading

* Add Error Handling, KeyExpr / String Conversion, updates to examples, small formatting and wording

* Migration Guide: Add Mode Dependent endpoints

* update clients-single endpoint

* docs: add sessions for zenoh-c specific and shallow copy

* docs: correct the `z_reply_ok` return type

* Minor cleanup and formatting

* Minor rewording of comments

* Update content/docs/migration_1.0/C++.md

* Update content/docs/migration_1.0/C_Pico.md

* Update content/docs/migration_1.0/Python.md

* Update content/docs/migration_1.0/Python.md

* Update C++: Attachment, Optional Parameters, and Update FIFO/Ring handler Code Block

* Apply suggestions from code review

Batch wording and format changes by @J-Loudet

Co-authored-by: J-Loudet <julien.loudet@zettascale.tech>

* Update content/docs/migration_1.0/C_Pico.md

* Add link RingChannel, and updated mentions of `prior v1.0.0` to 0.11.0

* Apply suggestions from code review

Review from Luca

Co-authored-by: Luca Cominardi <luca.cominardi@gmail.com>

* spelling

* Add Pico encoding values link to doc

* use permalink instead

* Apply suggestions from code review

Co-authored-by: Luca Cominardi <luca.cominardi@gmail.com>

* Add note on Copied and owned objects

* fix char spelling error

* Kotlin Migration guide

* Adding comment on Java migration guide

* reword Plugin loading for better clarity

* Fix small errors, rewording for clarity

* Reword keyexpr, removing question

* Update content/docs/migration_1.0/C_Pico.md

Co-authored-by: J-Loudet <julien.loudet@zettascale.tech>

---------

Co-authored-by: J-Loudet <julien.loudet@zettascale.tech>
Co-authored-by: Joseph Perez <joperez@hotmail.fr>
Co-authored-by: yuanyuyuan <az6980522@gmail.com>
Co-authored-by: Luca Cominardi <luca.cominardi@gmail.com>
Co-authored-by: Darius Maitia <darius@zettascale.tech>
  • Loading branch information
6 people authored Sep 10, 2024
1 parent 6d10baa commit b1a9624
Show file tree
Hide file tree
Showing 14 changed files with 2,221 additions and 9 deletions.
8 changes: 5 additions & 3 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ menu:
- identifier: "APIs"
name: "API"
weight: 4000
- identifier: "migration"
name: "Migration guides"
- identifier: "migration_0.5_to_0.6"
name: "Migration guides v0.5.x → v0.6.x"
weight: 5000

- identifier: "migration_1.0"
name: "Migration guides v0.11 → v1.0 "
weight: 6000
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Migrating from Zenoh-C v0.5.x zenoh-net API to Zenoh-C v0.6.x zenoh API"
weight : 5400
menu:
docs:
parent: migration
parent: migration_0.5_to_0.6
---

### Opening a session
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Migrating from Zenoh-Pico v0.5.x to Zenoh-Pico v0.6.x"
weight : 5600
menu:
docs:
parent: migration
parent: migration_0.5_to_0.6
---

## General considerations about the new Zenoh-Pico v0.6.x API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Migrating from Zenoh v0.5.x Python API to Zenoh v0.6.x Python API"
weight : 5500
menu:
docs:
parent: migration
parent: migration_0.5_to_0.6
---

## Explorability
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Migrating from Zenoh v0.5.x Rust API to Zenoh v0.6.x Rust API"
weight : 5300
menu:
docs:
parent: migration
parent: migration_0.5_to_0.6
---

In zenoh version 0.6.0, zenoh and zenoh-net APIs have been merged into a single API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Migrating from Zenoh-C to Zenoh-Pico (and vice-versa)"
weight : 5700
menu:
docs:
parent: migration
parent: migration_0.5_to_0.6
---

Both Zenoh-C and Zenoh-Pico APIs offer a C client API for the zenoh protocol, thus this release took an extra step to make Zenoh-C code to be compatible with Zenoh-Pico code (and vice-versa). Such approach aids users to easily migrate its Zenoh-based code to microcontrollers and embedded systems.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Migrating from Zenoh v0.5.x to Zenoh v0.6.x"
weight : 5200
menu:
docs:
parent: migration
parent: migration_0.5_to_0.6
---

## Key expressions
Expand Down
Loading

0 comments on commit b1a9624

Please sign in to comment.