From deda6719c7b3d24026d95b7ce90d944178e292ae Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Thu, 21 Jul 2022 20:18:32 +0430 Subject: [PATCH 01/15] initial work. --- .../core/zio/{ => type-aliases}/io.md | 0 .../core/zio/{ => type-aliases}/rio.md | 0 .../core/zio/{ => type-aliases}/task.md | 0 .../core/zio/{ => type-aliases}/uio.md | 0 .../core/zio/{ => type-aliases}/urio.md | 0 docs/references/index.md | 10 +++--- website/sidebars.js | 35 +++++++++++-------- 7 files changed, 26 insertions(+), 19 deletions(-) rename docs/references/core/zio/{ => type-aliases}/io.md (100%) rename docs/references/core/zio/{ => type-aliases}/rio.md (100%) rename docs/references/core/zio/{ => type-aliases}/task.md (100%) rename docs/references/core/zio/{ => type-aliases}/uio.md (100%) rename docs/references/core/zio/{ => type-aliases}/urio.md (100%) diff --git a/docs/references/core/zio/io.md b/docs/references/core/zio/type-aliases/io.md similarity index 100% rename from docs/references/core/zio/io.md rename to docs/references/core/zio/type-aliases/io.md diff --git a/docs/references/core/zio/rio.md b/docs/references/core/zio/type-aliases/rio.md similarity index 100% rename from docs/references/core/zio/rio.md rename to docs/references/core/zio/type-aliases/rio.md diff --git a/docs/references/core/zio/task.md b/docs/references/core/zio/type-aliases/task.md similarity index 100% rename from docs/references/core/zio/task.md rename to docs/references/core/zio/type-aliases/task.md diff --git a/docs/references/core/zio/uio.md b/docs/references/core/zio/type-aliases/uio.md similarity index 100% rename from docs/references/core/zio/uio.md rename to docs/references/core/zio/type-aliases/uio.md diff --git a/docs/references/core/zio/urio.md b/docs/references/core/zio/type-aliases/urio.md similarity index 100% rename from docs/references/core/zio/urio.md rename to docs/references/core/zio/type-aliases/urio.md diff --git a/docs/references/index.md b/docs/references/index.md index 8edc459becf2..25b983d9baf8 100644 --- a/docs/references/index.md +++ b/docs/references/index.md @@ -21,11 +21,11 @@ ZIO contains a few data types that can help you solve complex problems in asynch ## Core Data Types - **[ZIO](core/zio/zio.md)** — `ZIO` is a value that models an effectful program, which might fail or succeed. - + **[UIO](core/zio/uio.md)** — `UIO[A]` is a type alias for `ZIO[Any, Nothing, A]`. - + **[URIO](core/zio/urio.md)** — `URIO[R, A]` is a type alias for `ZIO[R, Nothing, A]`. - + **[Task](core/zio/task.md)** — `Task[A]` is a type alias for `ZIO[Any, Throwable, A]`. - + **[RIO](core/zio/rio.md)** — `RIO[R, A]` is a type alias for `ZIO[R, Throwable, A]`. - + **[IO](core/zio/io.md)** — `IO[E, A]` is a type alias for `ZIO[Any, E, A]`. + + **[UIO](core/zio/type-aliases/uio.md)** — `UIO[A]` is a type alias for `ZIO[Any, Nothing, A]`. + + **[URIO](core/zio/type-aliases/urio.md)** — `URIO[R, A]` is a type alias for `ZIO[R, Nothing, A]`. + + **[Task](core/zio/type-aliases/task.md)** — `Task[A]` is a type alias for `ZIO[Any, Throwable, A]`. + + **[RIO](core/zio/type-aliases/rio.md)** — `RIO[R, A]` is a type alias for `ZIO[R, Throwable, A]`. + + **[IO](core/zio/type-aliases/io.md)** — `IO[E, A]` is a type alias for `ZIO[Any, E, A]`. - **[ZIOApp](core/zioapp.md)** — `ZIOApp` and the `ZIOAppDefault` are entry points for ZIO applications. - **[Runtime](core/runtime.md)** — `Runtime[R]` is capable of executing tasks within an environment `R`. - **[Exit](core/exit.md)** — `Exit[E, A]` describes the result of executing an `IO` value. diff --git a/website/sidebars.js b/website/sidebars.js index 79cedc68ca14..8677fb137673 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -17,23 +17,30 @@ module.exports = { "references/index" ], "Core Data Types": [ - { + { + type: "category", + label: "ZIO Effects", + items: [ + "references/core/zio/zio", + { type: "category", - label: "ZIO Effects", + label: "Type Aliases", items: [ - "references/core/zio/zio", - "references/core/zio/error-management", - "references/core/zio/uio", - "references/core/zio/urio", - "references/core/zio/task", - "references/core/zio/rio", - "references/core/zio/io", + "references/core/zio/zio", + "references/core/zio/uio", + "references/core/zio/urio", + "references/core/zio/task", + "references/core/zio/rio", + "references/core/zio/io", ] - }, - "references/core/zioapp", - "references/core/runtime", - "references/core/exit", - "references/core/cause" + }, + "references/core/zio/error-management", + ] + }, + "references/core/zioapp", + "references/core/runtime", + "references/core/exit", + "references/core/cause" ], "Contextual Types": [ "references/contextual/index", From 3122f154639d57574cdce6cb19431f9f87cc45c7 Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Thu, 21 Jul 2022 20:22:31 +0430 Subject: [PATCH 02/15] revert directory movement. --- docs/references/core/zio/{type-aliases => }/io.md | 0 docs/references/core/zio/{type-aliases => }/rio.md | 0 docs/references/core/zio/{type-aliases => }/task.md | 0 docs/references/core/zio/{type-aliases => }/uio.md | 0 docs/references/core/zio/{type-aliases => }/urio.md | 0 docs/references/index.md | 10 +++++----- 6 files changed, 5 insertions(+), 5 deletions(-) rename docs/references/core/zio/{type-aliases => }/io.md (100%) rename docs/references/core/zio/{type-aliases => }/rio.md (100%) rename docs/references/core/zio/{type-aliases => }/task.md (100%) rename docs/references/core/zio/{type-aliases => }/uio.md (100%) rename docs/references/core/zio/{type-aliases => }/urio.md (100%) diff --git a/docs/references/core/zio/type-aliases/io.md b/docs/references/core/zio/io.md similarity index 100% rename from docs/references/core/zio/type-aliases/io.md rename to docs/references/core/zio/io.md diff --git a/docs/references/core/zio/type-aliases/rio.md b/docs/references/core/zio/rio.md similarity index 100% rename from docs/references/core/zio/type-aliases/rio.md rename to docs/references/core/zio/rio.md diff --git a/docs/references/core/zio/type-aliases/task.md b/docs/references/core/zio/task.md similarity index 100% rename from docs/references/core/zio/type-aliases/task.md rename to docs/references/core/zio/task.md diff --git a/docs/references/core/zio/type-aliases/uio.md b/docs/references/core/zio/uio.md similarity index 100% rename from docs/references/core/zio/type-aliases/uio.md rename to docs/references/core/zio/uio.md diff --git a/docs/references/core/zio/type-aliases/urio.md b/docs/references/core/zio/urio.md similarity index 100% rename from docs/references/core/zio/type-aliases/urio.md rename to docs/references/core/zio/urio.md diff --git a/docs/references/index.md b/docs/references/index.md index 25b983d9baf8..8edc459becf2 100644 --- a/docs/references/index.md +++ b/docs/references/index.md @@ -21,11 +21,11 @@ ZIO contains a few data types that can help you solve complex problems in asynch ## Core Data Types - **[ZIO](core/zio/zio.md)** — `ZIO` is a value that models an effectful program, which might fail or succeed. - + **[UIO](core/zio/type-aliases/uio.md)** — `UIO[A]` is a type alias for `ZIO[Any, Nothing, A]`. - + **[URIO](core/zio/type-aliases/urio.md)** — `URIO[R, A]` is a type alias for `ZIO[R, Nothing, A]`. - + **[Task](core/zio/type-aliases/task.md)** — `Task[A]` is a type alias for `ZIO[Any, Throwable, A]`. - + **[RIO](core/zio/type-aliases/rio.md)** — `RIO[R, A]` is a type alias for `ZIO[R, Throwable, A]`. - + **[IO](core/zio/type-aliases/io.md)** — `IO[E, A]` is a type alias for `ZIO[Any, E, A]`. + + **[UIO](core/zio/uio.md)** — `UIO[A]` is a type alias for `ZIO[Any, Nothing, A]`. + + **[URIO](core/zio/urio.md)** — `URIO[R, A]` is a type alias for `ZIO[R, Nothing, A]`. + + **[Task](core/zio/task.md)** — `Task[A]` is a type alias for `ZIO[Any, Throwable, A]`. + + **[RIO](core/zio/rio.md)** — `RIO[R, A]` is a type alias for `ZIO[R, Throwable, A]`. + + **[IO](core/zio/io.md)** — `IO[E, A]` is a type alias for `ZIO[Any, E, A]`. - **[ZIOApp](core/zioapp.md)** — `ZIOApp` and the `ZIOAppDefault` are entry points for ZIO applications. - **[Runtime](core/runtime.md)** — `Runtime[R]` is capable of executing tasks within an environment `R`. - **[Exit](core/exit.md)** — `Exit[E, A]` describes the result of executing an `IO` value. From 4f22cf6fdda5819bf9f121d4b23981adac10d75c Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 12:16:36 +0430 Subject: [PATCH 03/15] link the zio category to the zio page. --- website/sidebars.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 8677fb137673..722a339530f6 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -19,14 +19,14 @@ module.exports = { "Core Data Types": [ { type: "category", - label: "ZIO Effects", + link: {type: 'doc', id: 'references/core/zio/zio'}, + label: "ZIO", items: [ - "references/core/zio/zio", { type: "category", + collapsed: true, label: "Type Aliases", items: [ - "references/core/zio/zio", "references/core/zio/uio", "references/core/zio/urio", "references/core/zio/task", From b371964058848470c1a3d1f8633552a19834dc47 Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 12:33:43 +0430 Subject: [PATCH 04/15] index page for zio category. --- docs/references/core/index.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/references/core/index.md diff --git a/docs/references/core/index.md b/docs/references/core/index.md new file mode 100644 index 000000000000..ffb979e2bdf3 --- /dev/null +++ b/docs/references/core/index.md @@ -0,0 +1,17 @@ +--- +id: index +title: "Core Data Types" +--- + +In this section we are going to talk about the basic data types that are required to build a ZIO application: + +- **[ZIO](zio/zio.md)** — `ZIO` is a value that models an effectful program, which might fail or succeed. + + **[UIO](zio/uio.md)** — `UIO[A]` is a type alias for `ZIO[Any, Nothing, A]`. + + **[URIO](zio/urio.md)** — `URIO[R, A]` is a type alias for `ZIO[R, Nothing, A]`. + + **[Task](zio/task.md)** — `Task[A]` is a type alias for `ZIO[Any, Throwable, A]`. + + **[RIO](zio/rio.md)** — `RIO[R, A]` is a type alias for `ZIO[R, Throwable, A]`. + + **[IO](zio/io.md)** — `IO[E, A]` is a type alias for `ZIO[Any, E, A]`. +- **[ZIOApp](zioapp.md)** — `ZIOApp` and the `ZIOAppDefault` are entry points for ZIO applications. +- **[Runtime](runtime.md)** — `Runtime[R]` is capable of executing tasks within an environment `R`. +- **[Exit](exit.md)** — `Exit[E, A]` describes the result of executing an `IO` value. +- **[Cause](cause.md)** — `Cause[E]` is a description of a full story of a fiber failure. From 79f4a5e870b9d2e43a5cf463f2dcd7ca98e79959 Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 20:10:29 +0430 Subject: [PATCH 05/15] remove extra hierarchies. --- website/sidebars.js | 545 ++++++++++++++++++++++++-------------------- 1 file changed, 296 insertions(+), 249 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 722a339530f6..3d9fb90ccf1b 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1,6 +1,6 @@ module.exports = { - overview_sidebar: { - Overview: [ + overview_sidebar: + [ "overview/overview_index", "overview/overview_creating_effects", "overview/overview_basic_operations", @@ -10,185 +10,210 @@ module.exports = { "overview/overview_running_effects", "overview/overview_performance", "overview/overview_platforms" - ] - }, - "references-sidebar": { - "References": [ - "references/index" - ], - "Core Data Types": [ - { - type: "category", - link: {type: 'doc', id: 'references/core/zio/zio'}, - label: "ZIO", - items: [ - { - type: "category", - collapsed: true, - label: "Type Aliases", - items: [ - "references/core/zio/uio", - "references/core/zio/urio", - "references/core/zio/task", - "references/core/zio/rio", - "references/core/zio/io", - ] - }, - "references/core/zio/error-management", - ] - }, - "references/core/zioapp", - "references/core/runtime", - "references/core/exit", - "references/core/cause" ], - "Contextual Types": [ - "references/contextual/index", - "references/contextual/zenvironment", + "references-sidebar": [ + "references/index", + { + type: "category", + label: "Core Data Types", + items: [ { + type: "category", + link: { type: 'doc', id: 'references/core/zio/zio' }, + label: "ZIO", + items: [ + { + type: "category", + collapsed: true, + label: "Type Aliases", + items: [ + "references/core/zio/uio", + "references/core/zio/urio", + "references/core/zio/task", + "references/core/zio/rio", + "references/core/zio/io", + ] + }, + "references/core/zio/error-management", + ] + }, + "references/core/zioapp", + "references/core/runtime", + "references/core/exit", + "references/core/cause" + ] + }, + { + type: "category", + label: "Contextual Types", + items: + [ + "references/contextual/index", + "references/contextual/zenvironment", + { type: "category", label: "ZIO Layers", items: [ - "references/contextual/zlayer", - "references/contextual/rlayer", - "references/contextual/ulayer", - "references/contextual/layer", - "references/contextual/urlayer", - "references/contextual/tasklayer" + "references/contextual/zlayer", + "references/contextual/rlayer", + "references/contextual/ulayer", + "references/contextual/layer", + "references/contextual/urlayer", + "references/contextual/tasklayer" ] - }, - { + }, + { type: "category", label: "Built-in Services", items: [ - "references/contextual/services/index", - "references/contextual/services/console", - "references/contextual/services/clock", - "references/contextual/services/random", - "references/contextual/services/system" + "references/contextual/services/index", + "references/contextual/services/console", + "references/contextual/services/clock", + "references/contextual/services/random", + "references/contextual/services/system" ] - } - ], - "Concurrency": [ + } + ] + }, + { + type: "category", + label: "Concurrency", + items: [ { - type: "category", - label: "ZIO Fibers", - items: [ - "references/fiber/index", - "references/fiber/fiber", - "references/fiber/fiberref", - "references/fiber/fiberid", - "references/fiber/fiberstatus" - ] + type: "category", + label: "ZIO Fibers", + items: [ + "references/fiber/index", + "references/fiber/fiber", + "references/fiber/fiberref", + "references/fiber/fiberid", + "references/fiber/fiberstatus" + ] }, { - type: "category", - label: "Synchronization", - items: [ - "references/sync/index", - "references/sync/reentrantlock", - "references/sync/countdownlatch", - "references/sync/cyclicbarrier", - "references/sync/concurrentmap", - "references/sync/concurrentset", - ] + type: "category", + label: "Synchronization", + items: [ + "references/sync/index", + "references/sync/reentrantlock", + "references/sync/countdownlatch", + "references/sync/cyclicbarrier", + "references/sync/concurrentmap", + "references/sync/concurrentset", + ] }, { - type: "category", - label: "Concurrency Primitives", - items: [ - "references/concurrency/index", - { - type: "category", - label: "Mutable References", - items: [ - "references/concurrency/ref", - "references/concurrency/refsynchronized", - ] - }, - "references/concurrency/promise", - "references/concurrency/queue", - "references/concurrency/hub", - "references/concurrency/semaphore" - ] + type: "category", + label: "Concurrency Primitives", + items: [ + "references/concurrency/index", + { + type: "category", + label: "Mutable References", + items: [ + "references/concurrency/ref", + "references/concurrency/refsynchronized", + ] + }, + "references/concurrency/promise", + "references/concurrency/queue", + "references/concurrency/hub", + "references/concurrency/semaphore" + ] }, { - type: "category", - label: "STM", - items: [ - "references/stm/index", - "references/stm/stm", - "references/stm/tarray", - "references/stm/trandom", - "references/stm/tset", - "references/stm/tmap", - "references/stm/tref", - "references/stm/tpriorityqueue", - "references/stm/tpromise", - "references/stm/tqueue", - "references/stm/treentrantlock", - "references/stm/tsemaphore", - "references/stm/thub", - ] + type: "category", + label: "STM", + items: [ + "references/stm/index", + "references/stm/stm", + "references/stm/tarray", + "references/stm/trandom", + "references/stm/tset", + "references/stm/tmap", + "references/stm/tref", + "references/stm/tpriorityqueue", + "references/stm/tpromise", + "references/stm/tqueue", + "references/stm/treentrantlock", + "references/stm/tsemaphore", + "references/stm/thub", + ] }, - ], - "Resource Management": [ - "references/resource/index", - "references/resource/scope", - "references/resource/zpool", - ], - "Streaming": [ + ] + }, + { + type: "category", + label: "Resource Management", + items: [ + "references/resource/index", + "references/resource/scope", + "references/resource/zpool", + ] + }, + { + type: "category", + label: "Streaming", + items: [ "references/stream/index", { - type: "category", - label: "Main Components", - items: [ - { - type: "category", - label: "ZStream", - items: [ - "references/stream/zstream", - "references/stream/stream", - "references/stream/ustream", - ] - }, - { - type: "category", - label: "ZPipeline", - items: [ - "references/stream/zpipeline", - ] - }, - { - type: "category", - label: "ZSink", - items: [ - "references/stream/zsink", - "references/stream/sink", - ] - }, - "references/stream/zchannel" - ] - }, - "references/stream/subscription-ref" - ], - "Metrics": [ - "references/metrics/index", - { + type: "category", + label: "Main Components", + items: [ + { type: "category", - label: "Metric Types", + label: "ZStream", items: [ - "references/metrics/counter", - "references/metrics/gauge", - "references/metrics/histogram", - "references/metrics/summary", - "references/metrics/setcount" + "references/stream/zstream", + "references/stream/stream", + "references/stream/ustream", ] - }, - "references/metrics/metriclabel", - "references/metrics/jvm", - ], - "Testing": [ + }, + { + type: "category", + label: "ZPipeline", + items: [ + "references/stream/zpipeline", + ] + }, + { + type: "category", + label: "ZSink", + items: [ + "references/stream/zsink", + "references/stream/sink", + ] + }, + "references/stream/zchannel" + ] + }, + "references/stream/subscription-ref" + ] + }, + { + type: "category", + label: "Metrics", + items: [ + "references/metrics/index", + { + type: "category", + label: "Metric Types", + items: [ + "references/metrics/counter", + "references/metrics/gauge", + "references/metrics/histogram", + "references/metrics/summary", + "references/metrics/setcount" + ] + }, + "references/metrics/metriclabel", + "references/metrics/jvm", + ] + }, + { + type: "category", + label: "Testing", + items: [ "references/test/index", "references/test/spec", "references/test/assertion", @@ -208,28 +233,37 @@ module.exports = { }, "references/test/test-aspect", "references/test/gen", - ], - "Miscellaneous": [ - "references/misc/chunk", - "references/misc/schedule", - "references/misc/supervisor", - "references/misc/zstate", - ] - }, + ] + }, + { + type: "category", + label: "Miscellaneous", + items: [ + "references/misc/chunk", + "references/misc/schedule", + "references/misc/supervisor", + "references/misc/zstate", + ] + } + ], "guides-sidebar": [ + "guides/index", { - "Guides" : [ - "guides/index", - ], - "Quickstart Guides": [ + type: "category", + label: "Quickstart Guides", + items: [ "guides/quickstarts/hello-world", - "guides/quickstarts/restful-webservice", + "guides/quickstarts/restful-webservice", "guides/quickstarts/graphql-webservice", - ], - "Tutorial Guides": [ + ] + }, + { + type: "category", + label: "Tutorial Guides", + items: [ "guides/tutorials/configurable-zio-application", - "guides/tutorials/encode-and-decode-json-data", - "guides/tutorials/enable-logging-in-a-zio-application", + "guides/tutorials/encode-and-decode-json-data", + "guides/tutorials/enable-logging-in-a-zio-application", "guides/tutorials/create-custom-logger-for-a-zio-application", "guides/tutorials/run-our-first-zio-project-with-vscode", "guides/tutorials/run-our-first-zio-project-with-intellij-idea", @@ -239,8 +273,12 @@ module.exports = { "guides/tutorials/debug-a-zio-application", "guides/tutorials/build-a-restful-webservice", "guides/tutorials/build-a-graphql-webservice", - ], - "Integration Guides": [ + ] + }, + { + type: "category", + label: "Integration Guides", + items: [ "guides/interop/with-cats-effect", "guides/interop/with-future", "guides/interop/with-java", @@ -250,90 +288,100 @@ module.exports = { "guides/interop/with-reactive-streams", "guides/interop/with-twitter", "guides/interop/with-guava" - ], - "Migration Guides": [ + ] + }, + { + type: "category", + label: "Migration Guides", + items: [ "guides/migrate/zio-2.x-migration-guide", "guides/migrate/from-cats-effect", "guides/migrate/from-monix", ] } ], - "resources-sidebar": { - "Resources": [ - "resources/index" - ], - "Learning": [ - "resources/learning/articles", - "resources/learning/videos", - "resources/learning/cookbooks", - "resources/learning/cheatsheets", - "resources/learning/sampleprojects", - "resources/learning/poweredbyzio" - ], - "Ecosystem": [ + "resources-sidebar": [ + "resources/index", + { + type: "category", + label: "Learning", + items: [ + "resources/learning/articles", + "resources/learning/videos", + "resources/learning/cookbooks", + "resources/learning/cheatsheets", + "resources/learning/sampleprojects", + "resources/learning/poweredbyzio" + ] + }, + { + type: "category", + label: "Ecosystem", + items: [ { - type: "category", - label: "Official Libraries", - items: [ - "resources/ecosystem/officials/index", - "resources/ecosystem/officials/zio-actors", - "resources/ecosystem/officials/zio-akka-cluster", - "resources/ecosystem/officials/zio-aws", - "resources/ecosystem/officials/zio-cache", - "resources/ecosystem/officials/zio-config", - "resources/ecosystem/officials/zio-ftp", - "resources/ecosystem/officials/zio-json", - "resources/ecosystem/officials/zio-kafka", - "resources/ecosystem/officials/zio-logging", - "resources/ecosystem/officials/zio-metrics", - "resources/ecosystem/officials/zio-mock", - "resources/ecosystem/officials/zio-nio", - "resources/ecosystem/officials/zio-optics", - "resources/ecosystem/officials/zio-prelude", - "resources/ecosystem/officials/zio-process", - "resources/ecosystem/officials/zio-query", - "resources/ecosystem/officials/zio-redis", - "resources/ecosystem/officials/zio-rocksdb", - "resources/ecosystem/officials/zio-s3", - "resources/ecosystem/officials/zio-schema", - "resources/ecosystem/officials/zio-sqs", - "resources/ecosystem/officials/zio-telemetry", - "resources/ecosystem/officials/zio-zmx", - ], + type: "category", + label: "Official Libraries", + items: [ + "resources/ecosystem/officials/index", + "resources/ecosystem/officials/zio-actors", + "resources/ecosystem/officials/zio-akka-cluster", + "resources/ecosystem/officials/zio-aws", + "resources/ecosystem/officials/zio-cache", + "resources/ecosystem/officials/zio-config", + "resources/ecosystem/officials/zio-ftp", + "resources/ecosystem/officials/zio-json", + "resources/ecosystem/officials/zio-kafka", + "resources/ecosystem/officials/zio-logging", + "resources/ecosystem/officials/zio-metrics", + "resources/ecosystem/officials/zio-mock", + "resources/ecosystem/officials/zio-nio", + "resources/ecosystem/officials/zio-optics", + "resources/ecosystem/officials/zio-prelude", + "resources/ecosystem/officials/zio-process", + "resources/ecosystem/officials/zio-query", + "resources/ecosystem/officials/zio-redis", + "resources/ecosystem/officials/zio-rocksdb", + "resources/ecosystem/officials/zio-s3", + "resources/ecosystem/officials/zio-schema", + "resources/ecosystem/officials/zio-sqs", + "resources/ecosystem/officials/zio-telemetry", + "resources/ecosystem/officials/zio-zmx", + ] }, { - type: "category", - label: "Community Libraries", - items: [ - "resources/ecosystem/community/index", - "resources/ecosystem/community/caliban", - "resources/ecosystem/community/distage", - "resources/ecosystem/community/logstage", - "resources/ecosystem/community/munit-zio", - "resources/ecosystem/community/quill", - "resources/ecosystem/community/rezilience", - "resources/ecosystem/community/tamer", - "resources/ecosystem/community/tranzactio", - "resources/ecosystem/community/zio-amqp", - "resources/ecosystem/community/zio-arrow", - "resources/ecosystem/community/zio-aws-s3", - "resources/ecosystem/community/zio-grpc", - "resources/ecosystem/community/zio-http", - "resources/ecosystem/community/zio-k8s", - "resources/ecosystem/community/zio-kinesis", - "resources/ecosystem/community/zio-pulsar", - "resources/ecosystem/community/zio-saga", - "resources/ecosystem/community/zio-slick-interop", - "resources/ecosystem/community/zio-test-akka-http", - ], + type: "category", + label: "Community Libraries", + items: [ + "resources/ecosystem/community/index", + "resources/ecosystem/community/caliban", + "resources/ecosystem/community/distage", + "resources/ecosystem/community/logstage", + "resources/ecosystem/community/munit-zio", + "resources/ecosystem/community/quill", + "resources/ecosystem/community/rezilience", + "resources/ecosystem/community/tamer", + "resources/ecosystem/community/tranzactio", + "resources/ecosystem/community/zio-amqp", + "resources/ecosystem/community/zio-arrow", + "resources/ecosystem/community/zio-aws-s3", + "resources/ecosystem/community/zio-grpc", + "resources/ecosystem/community/zio-http", + "resources/ecosystem/community/zio-k8s", + "resources/ecosystem/community/zio-kinesis", + "resources/ecosystem/community/zio-pulsar", + "resources/ecosystem/community/zio-saga", + "resources/ecosystem/community/zio-slick-interop", + "resources/ecosystem/community/zio-test-akka-http", + ], }, "resources/ecosystem/compatible", "resources/ecosystem/tools", "resources/ecosystem/templates" - ] - }, - "about-sidebar": { - "About": [ + ] + } + ], + "about-sidebar": + [ "about/about_index", "about/faq", "about/coding-guidelines", @@ -342,5 +390,4 @@ module.exports = { "about/code-of-conduct", "about/users", ] - } } From a8118ffbecedad2ffc2be6f4768f3c72d95330fc Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 13:40:32 +0430 Subject: [PATCH 06/15] expand some sections for better user experience. --- website/sidebars.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/sidebars.js b/website/sidebars.js index 3d9fb90ccf1b..9db5f2fbc4b8 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -16,6 +16,7 @@ module.exports = { { type: "category", label: "Core Data Types", + collapsed: false, items: [ { type: "category", @@ -251,6 +252,7 @@ module.exports = { { type: "category", label: "Quickstart Guides", + collapsed: false, items: [ "guides/quickstarts/hello-world", "guides/quickstarts/restful-webservice", @@ -305,6 +307,7 @@ module.exports = { { type: "category", label: "Learning", + collapsed: false, items: [ "resources/learning/articles", "resources/learning/videos", @@ -317,6 +320,7 @@ module.exports = { { type: "category", label: "Ecosystem", + collapsed: false, items: [ { type: "category", From 525e3124498c3eaea163d5dc50c489b191156df2 Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 13:53:01 +0430 Subject: [PATCH 07/15] make migration guide expanded. --- website/sidebars.js | 1 + 1 file changed, 1 insertion(+) diff --git a/website/sidebars.js b/website/sidebars.js index 9db5f2fbc4b8..f5bb5fa4025f 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -295,6 +295,7 @@ module.exports = { { type: "category", label: "Migration Guides", + collapsed: false, items: [ "guides/migrate/zio-2.x-migration-guide", "guides/migrate/from-cats-effect", From 0a3343879f7385d02755f8e0eadf8da17fc0fbfc Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 13:55:27 +0430 Subject: [PATCH 08/15] better naming on sidebar. --- docs/guides/migrate/from-cats-effect.md | 1 + docs/guides/migrate/from-monix.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/guides/migrate/from-cats-effect.md b/docs/guides/migrate/from-cats-effect.md index f561c5afe301..8b2ab1619e4d 100644 --- a/docs/guides/migrate/from-cats-effect.md +++ b/docs/guides/migrate/from-cats-effect.md @@ -1,6 +1,7 @@ --- id: from-cats-effect title: "How to Migrate from Cats Effect to ZIO?" +sidebar_label: "Migration from Cats Effect" --- Cats `IO[A]` can be easily replaced with ZIO's `Task[A]` (an alias for `ZIO[Any, Throwable, A]`). diff --git a/docs/guides/migrate/from-monix.md b/docs/guides/migrate/from-monix.md index 42cabbcdb67d..08f9986ab796 100644 --- a/docs/guides/migrate/from-monix.md +++ b/docs/guides/migrate/from-monix.md @@ -1,6 +1,7 @@ --- id: from-monix title: "How to Migrate from Monix to ZIO?" +sidebar_label: "Migration from Monix" --- Monix's `Task[A]` can be easily replaced with ZIO's `Task[A]` (an alias for `ZIO[Any, Throwable, A]`). From 89b0356c5532a8817212509ce0531ed797e050df Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 18:59:57 +0430 Subject: [PATCH 09/15] rename references to reference. --- docs/guides/migrate/migration-guide.md | 2 +- ...oduce-consume-data-to-from-kafka-topics.md | 2 +- docs/overview/handling_errors.md | 2 +- .../concurrency/hub.md | 0 .../concurrency/index.md | 0 .../concurrency/promise.md | 0 .../concurrency/queue.md | 0 .../concurrency/ref.md | 0 .../concurrency/refsynchronized.md | 0 .../concurrency/semaphore.md | 0 .../contextual/index.md | 0 .../contextual/layer.md | 0 .../contextual/rlayer.md | 0 .../contextual/services/clock.md | 0 .../contextual/services/console.md | 0 .../contextual/services/index.md | 0 .../contextual/services/random.md | 0 .../contextual/services/system.md | 0 .../contextual/task-layer.md | 0 .../contextual/ulayer.md | 0 .../contextual/urlayer.md | 0 .../contextual/zenvironment.md | 0 .../contextual/zlayer.md | 0 docs/{references => reference}/core/cause.md | 0 docs/{references => reference}/core/exit.md | 0 docs/{references => reference}/core/index.md | 0 .../{references => reference}/core/runtime.md | 0 .../core/zio/error-management.md | 0 docs/{references => reference}/core/zio/io.md | 0 .../{references => reference}/core/zio/rio.md | 0 .../core/zio/task.md | 0 .../{references => reference}/core/zio/uio.md | 0 .../core/zio/urio.md | 0 .../{references => reference}/core/zio/zio.md | 0 docs/{references => reference}/core/zioapp.md | 0 docs/{references => reference}/fiber/fiber.md | 0 .../fiber/fiberid.md | 0 .../fiber/fiberref.md | 0 .../fiber/fiberstatus.md | 0 docs/{references => reference}/fiber/index.md | 0 docs/{references => reference}/index.md | 0 .../metrics/counter.md | 0 .../metrics/gauge.md | 0 .../metrics/histogram.md | 0 .../metrics/index.md | 0 docs/{references => reference}/metrics/jvm.md | 0 .../metrics/metriclabel.md | 0 .../metrics/setcount.md | 0 .../metrics/summary.md | 0 docs/{references => reference}/misc/chunk.md | 0 .../misc/schedule.md | 0 .../misc/supervisor.md | 0 docs/{references => reference}/misc/zstate.md | 0 .../resource/index.md | 0 .../resource/scope.md | 0 .../resource/zpool.md | 0 docs/{references => reference}/stm/index.md | 0 docs/{references => reference}/stm/stm.md | 0 docs/{references => reference}/stm/tarray.md | 0 docs/{references => reference}/stm/thub.md | 0 docs/{references => reference}/stm/tmap.md | 0 .../stm/tpriorityqueue.md | 0 .../{references => reference}/stm/tpromise.md | 0 docs/{references => reference}/stm/tqueue.md | 0 docs/{references => reference}/stm/trandom.md | 0 .../stm/treentrantlock.md | 0 docs/{references => reference}/stm/tref.md | 0 .../stm/tsemaphore.md | 0 docs/{references => reference}/stm/tset.md | 0 .../{references => reference}/stream/index.md | 0 docs/{references => reference}/stream/sink.md | 0 .../stream/stream.md | 0 .../stream/subscriptionref.md | 0 .../stream/ustream.md | 0 .../stream/zchannel.md | 0 .../stream/zpipeline.md | 0 .../{references => reference}/stream/zsink.md | 0 .../stream/zstream.md | 0 .../sync/concurrentmap.md | 0 .../sync/concurrentset.md | 0 .../sync/countdownlatch.md | 0 .../sync/cyclicbarrier.md | 0 docs/{references => reference}/sync/index.md | 0 docs/{references => reference}/sync/mvar.md | 0 .../sync/reentrantlock.md | 0 .../test/assertion.md | 0 .../test/environment/clock.md | 0 .../test/environment/console.md | 0 .../test/environment/index.md | 0 .../test/environment/live.md | 0 .../test/environment/random.md | 0 .../test/environment/sized.md | 0 .../test/environment/system.md | 0 .../test/environment/test-config.md | 0 docs/{references => reference}/test/gen.md | 0 docs/{references => reference}/test/index.md | 0 docs/{references => reference}/test/spec.md | 0 .../test/test-aspect.md | 0 .../resources/ecosystem/officials/zio-mock.md | 2 +- .../zio/internal/TerminalRendering.scala | 2 +- website/docusaurus.config.js | 2 +- website/sidebars.js | 190 +++++++++--------- website/version2-only-docusaurus.config.js | 2 +- 103 files changed, 102 insertions(+), 102 deletions(-) rename docs/{references => reference}/concurrency/hub.md (100%) rename docs/{references => reference}/concurrency/index.md (100%) rename docs/{references => reference}/concurrency/promise.md (100%) rename docs/{references => reference}/concurrency/queue.md (100%) rename docs/{references => reference}/concurrency/ref.md (100%) rename docs/{references => reference}/concurrency/refsynchronized.md (100%) rename docs/{references => reference}/concurrency/semaphore.md (100%) rename docs/{references => reference}/contextual/index.md (100%) rename docs/{references => reference}/contextual/layer.md (100%) rename docs/{references => reference}/contextual/rlayer.md (100%) rename docs/{references => reference}/contextual/services/clock.md (100%) rename docs/{references => reference}/contextual/services/console.md (100%) rename docs/{references => reference}/contextual/services/index.md (100%) rename docs/{references => reference}/contextual/services/random.md (100%) rename docs/{references => reference}/contextual/services/system.md (100%) rename docs/{references => reference}/contextual/task-layer.md (100%) rename docs/{references => reference}/contextual/ulayer.md (100%) rename docs/{references => reference}/contextual/urlayer.md (100%) rename docs/{references => reference}/contextual/zenvironment.md (100%) rename docs/{references => reference}/contextual/zlayer.md (100%) rename docs/{references => reference}/core/cause.md (100%) rename docs/{references => reference}/core/exit.md (100%) rename docs/{references => reference}/core/index.md (100%) rename docs/{references => reference}/core/runtime.md (100%) rename docs/{references => reference}/core/zio/error-management.md (100%) rename docs/{references => reference}/core/zio/io.md (100%) rename docs/{references => reference}/core/zio/rio.md (100%) rename docs/{references => reference}/core/zio/task.md (100%) rename docs/{references => reference}/core/zio/uio.md (100%) rename docs/{references => reference}/core/zio/urio.md (100%) rename docs/{references => reference}/core/zio/zio.md (100%) rename docs/{references => reference}/core/zioapp.md (100%) rename docs/{references => reference}/fiber/fiber.md (100%) rename docs/{references => reference}/fiber/fiberid.md (100%) rename docs/{references => reference}/fiber/fiberref.md (100%) rename docs/{references => reference}/fiber/fiberstatus.md (100%) rename docs/{references => reference}/fiber/index.md (100%) rename docs/{references => reference}/index.md (100%) rename docs/{references => reference}/metrics/counter.md (100%) rename docs/{references => reference}/metrics/gauge.md (100%) rename docs/{references => reference}/metrics/histogram.md (100%) rename docs/{references => reference}/metrics/index.md (100%) rename docs/{references => reference}/metrics/jvm.md (100%) rename docs/{references => reference}/metrics/metriclabel.md (100%) rename docs/{references => reference}/metrics/setcount.md (100%) rename docs/{references => reference}/metrics/summary.md (100%) rename docs/{references => reference}/misc/chunk.md (100%) rename docs/{references => reference}/misc/schedule.md (100%) rename docs/{references => reference}/misc/supervisor.md (100%) rename docs/{references => reference}/misc/zstate.md (100%) rename docs/{references => reference}/resource/index.md (100%) rename docs/{references => reference}/resource/scope.md (100%) rename docs/{references => reference}/resource/zpool.md (100%) rename docs/{references => reference}/stm/index.md (100%) rename docs/{references => reference}/stm/stm.md (100%) rename docs/{references => reference}/stm/tarray.md (100%) rename docs/{references => reference}/stm/thub.md (100%) rename docs/{references => reference}/stm/tmap.md (100%) rename docs/{references => reference}/stm/tpriorityqueue.md (100%) rename docs/{references => reference}/stm/tpromise.md (100%) rename docs/{references => reference}/stm/tqueue.md (100%) rename docs/{references => reference}/stm/trandom.md (100%) rename docs/{references => reference}/stm/treentrantlock.md (100%) rename docs/{references => reference}/stm/tref.md (100%) rename docs/{references => reference}/stm/tsemaphore.md (100%) rename docs/{references => reference}/stm/tset.md (100%) rename docs/{references => reference}/stream/index.md (100%) rename docs/{references => reference}/stream/sink.md (100%) rename docs/{references => reference}/stream/stream.md (100%) rename docs/{references => reference}/stream/subscriptionref.md (100%) rename docs/{references => reference}/stream/ustream.md (100%) rename docs/{references => reference}/stream/zchannel.md (100%) rename docs/{references => reference}/stream/zpipeline.md (100%) rename docs/{references => reference}/stream/zsink.md (100%) rename docs/{references => reference}/stream/zstream.md (100%) rename docs/{references => reference}/sync/concurrentmap.md (100%) rename docs/{references => reference}/sync/concurrentset.md (100%) rename docs/{references => reference}/sync/countdownlatch.md (100%) rename docs/{references => reference}/sync/cyclicbarrier.md (100%) rename docs/{references => reference}/sync/index.md (100%) rename docs/{references => reference}/sync/mvar.md (100%) rename docs/{references => reference}/sync/reentrantlock.md (100%) rename docs/{references => reference}/test/assertion.md (100%) rename docs/{references => reference}/test/environment/clock.md (100%) rename docs/{references => reference}/test/environment/console.md (100%) rename docs/{references => reference}/test/environment/index.md (100%) rename docs/{references => reference}/test/environment/live.md (100%) rename docs/{references => reference}/test/environment/random.md (100%) rename docs/{references => reference}/test/environment/sized.md (100%) rename docs/{references => reference}/test/environment/system.md (100%) rename docs/{references => reference}/test/environment/test-config.md (100%) rename docs/{references => reference}/test/gen.md (100%) rename docs/{references => reference}/test/index.md (100%) rename docs/{references => reference}/test/spec.md (100%) rename docs/{references => reference}/test/test-aspect.md (100%) diff --git a/docs/guides/migrate/migration-guide.md b/docs/guides/migrate/migration-guide.md index 7f911f921d02..5289214212e1 100644 --- a/docs/guides/migrate/migration-guide.md +++ b/docs/guides/migrate/migration-guide.md @@ -2623,7 +2623,7 @@ for { } yield () ``` -Visit the [Hub](../../references/concurrency/hub) page to learn more about it. +Visit the [Hub](../../reference/concurrency/hub) page to learn more about it. ### ZIO Aspects diff --git a/docs/guides/tutorials/produce-consume-data-to-from-kafka-topics.md b/docs/guides/tutorials/produce-consume-data-to-from-kafka-topics.md index 1b484113b2c3..9d09bc19e76d 100644 --- a/docs/guides/tutorials/produce-consume-data-to-from-kafka-topics.md +++ b/docs/guides/tutorials/produce-consume-data-to-from-kafka-topics.md @@ -43,7 +43,7 @@ libraryDependencies += Seq( 1. **ZIO Kafka** is a ZIO native client for Apache Kafka. It has a high-level streaming API on top of the Java client. So we can produce and consume events using the declarative concurrency model of ZIO Streams. -2. **ZIO Stream** introduces a high-level API for working with streams of values. It is designated to work in a highly concurrent environment. It has seamless integration with ZIO, so we have the ability to use all the features of the ZIO along with the streams, e.g. `Scope`, `Schedule`, `ZLayer`, `Quque`, `Hub` etc. To learn more about ZIO Stream, we have a comprehensive section in on that [here](../../references/stream/index.md). +2. **ZIO Stream** introduces a high-level API for working with streams of values. It is designated to work in a highly concurrent environment. It has seamless integration with ZIO, so we have the ability to use all the features of the ZIO along with the streams, e.g. `Scope`, `Schedule`, `ZLayer`, `Quque`, `Hub` etc. To learn more about ZIO Stream, we have a comprehensive section in on that [here](../../reference/stream/index.md). 3. **ZIO JSON** is a library to serialize and deserialize data from/to JSON data type. We will be using this library to serialize and deserialize data when reading and writing JSON data from/to Kafka topics. diff --git a/docs/overview/handling_errors.md b/docs/overview/handling_errors.md index 6f241aceac7f..76bf9f61c90c 100644 --- a/docs/overview/handling_errors.md +++ b/docs/overview/handling_errors.md @@ -135,7 +135,7 @@ val retryOpenFile: ZIO[Any, IOException, DefaultData) = .retryOrElse(Schedule.recurs(5), (_, _) => ZIO.succeed(DefaultData)) ``` -For more information on how to build schedules, see the documentation on [Schedule](../references/misc/schedule.md). +For more information on how to build schedules, see the documentation on [Schedule](../reference/misc/schedule.md). ## Next Steps diff --git a/docs/references/concurrency/hub.md b/docs/reference/concurrency/hub.md similarity index 100% rename from docs/references/concurrency/hub.md rename to docs/reference/concurrency/hub.md diff --git a/docs/references/concurrency/index.md b/docs/reference/concurrency/index.md similarity index 100% rename from docs/references/concurrency/index.md rename to docs/reference/concurrency/index.md diff --git a/docs/references/concurrency/promise.md b/docs/reference/concurrency/promise.md similarity index 100% rename from docs/references/concurrency/promise.md rename to docs/reference/concurrency/promise.md diff --git a/docs/references/concurrency/queue.md b/docs/reference/concurrency/queue.md similarity index 100% rename from docs/references/concurrency/queue.md rename to docs/reference/concurrency/queue.md diff --git a/docs/references/concurrency/ref.md b/docs/reference/concurrency/ref.md similarity index 100% rename from docs/references/concurrency/ref.md rename to docs/reference/concurrency/ref.md diff --git a/docs/references/concurrency/refsynchronized.md b/docs/reference/concurrency/refsynchronized.md similarity index 100% rename from docs/references/concurrency/refsynchronized.md rename to docs/reference/concurrency/refsynchronized.md diff --git a/docs/references/concurrency/semaphore.md b/docs/reference/concurrency/semaphore.md similarity index 100% rename from docs/references/concurrency/semaphore.md rename to docs/reference/concurrency/semaphore.md diff --git a/docs/references/contextual/index.md b/docs/reference/contextual/index.md similarity index 100% rename from docs/references/contextual/index.md rename to docs/reference/contextual/index.md diff --git a/docs/references/contextual/layer.md b/docs/reference/contextual/layer.md similarity index 100% rename from docs/references/contextual/layer.md rename to docs/reference/contextual/layer.md diff --git a/docs/references/contextual/rlayer.md b/docs/reference/contextual/rlayer.md similarity index 100% rename from docs/references/contextual/rlayer.md rename to docs/reference/contextual/rlayer.md diff --git a/docs/references/contextual/services/clock.md b/docs/reference/contextual/services/clock.md similarity index 100% rename from docs/references/contextual/services/clock.md rename to docs/reference/contextual/services/clock.md diff --git a/docs/references/contextual/services/console.md b/docs/reference/contextual/services/console.md similarity index 100% rename from docs/references/contextual/services/console.md rename to docs/reference/contextual/services/console.md diff --git a/docs/references/contextual/services/index.md b/docs/reference/contextual/services/index.md similarity index 100% rename from docs/references/contextual/services/index.md rename to docs/reference/contextual/services/index.md diff --git a/docs/references/contextual/services/random.md b/docs/reference/contextual/services/random.md similarity index 100% rename from docs/references/contextual/services/random.md rename to docs/reference/contextual/services/random.md diff --git a/docs/references/contextual/services/system.md b/docs/reference/contextual/services/system.md similarity index 100% rename from docs/references/contextual/services/system.md rename to docs/reference/contextual/services/system.md diff --git a/docs/references/contextual/task-layer.md b/docs/reference/contextual/task-layer.md similarity index 100% rename from docs/references/contextual/task-layer.md rename to docs/reference/contextual/task-layer.md diff --git a/docs/references/contextual/ulayer.md b/docs/reference/contextual/ulayer.md similarity index 100% rename from docs/references/contextual/ulayer.md rename to docs/reference/contextual/ulayer.md diff --git a/docs/references/contextual/urlayer.md b/docs/reference/contextual/urlayer.md similarity index 100% rename from docs/references/contextual/urlayer.md rename to docs/reference/contextual/urlayer.md diff --git a/docs/references/contextual/zenvironment.md b/docs/reference/contextual/zenvironment.md similarity index 100% rename from docs/references/contextual/zenvironment.md rename to docs/reference/contextual/zenvironment.md diff --git a/docs/references/contextual/zlayer.md b/docs/reference/contextual/zlayer.md similarity index 100% rename from docs/references/contextual/zlayer.md rename to docs/reference/contextual/zlayer.md diff --git a/docs/references/core/cause.md b/docs/reference/core/cause.md similarity index 100% rename from docs/references/core/cause.md rename to docs/reference/core/cause.md diff --git a/docs/references/core/exit.md b/docs/reference/core/exit.md similarity index 100% rename from docs/references/core/exit.md rename to docs/reference/core/exit.md diff --git a/docs/references/core/index.md b/docs/reference/core/index.md similarity index 100% rename from docs/references/core/index.md rename to docs/reference/core/index.md diff --git a/docs/references/core/runtime.md b/docs/reference/core/runtime.md similarity index 100% rename from docs/references/core/runtime.md rename to docs/reference/core/runtime.md diff --git a/docs/references/core/zio/error-management.md b/docs/reference/core/zio/error-management.md similarity index 100% rename from docs/references/core/zio/error-management.md rename to docs/reference/core/zio/error-management.md diff --git a/docs/references/core/zio/io.md b/docs/reference/core/zio/io.md similarity index 100% rename from docs/references/core/zio/io.md rename to docs/reference/core/zio/io.md diff --git a/docs/references/core/zio/rio.md b/docs/reference/core/zio/rio.md similarity index 100% rename from docs/references/core/zio/rio.md rename to docs/reference/core/zio/rio.md diff --git a/docs/references/core/zio/task.md b/docs/reference/core/zio/task.md similarity index 100% rename from docs/references/core/zio/task.md rename to docs/reference/core/zio/task.md diff --git a/docs/references/core/zio/uio.md b/docs/reference/core/zio/uio.md similarity index 100% rename from docs/references/core/zio/uio.md rename to docs/reference/core/zio/uio.md diff --git a/docs/references/core/zio/urio.md b/docs/reference/core/zio/urio.md similarity index 100% rename from docs/references/core/zio/urio.md rename to docs/reference/core/zio/urio.md diff --git a/docs/references/core/zio/zio.md b/docs/reference/core/zio/zio.md similarity index 100% rename from docs/references/core/zio/zio.md rename to docs/reference/core/zio/zio.md diff --git a/docs/references/core/zioapp.md b/docs/reference/core/zioapp.md similarity index 100% rename from docs/references/core/zioapp.md rename to docs/reference/core/zioapp.md diff --git a/docs/references/fiber/fiber.md b/docs/reference/fiber/fiber.md similarity index 100% rename from docs/references/fiber/fiber.md rename to docs/reference/fiber/fiber.md diff --git a/docs/references/fiber/fiberid.md b/docs/reference/fiber/fiberid.md similarity index 100% rename from docs/references/fiber/fiberid.md rename to docs/reference/fiber/fiberid.md diff --git a/docs/references/fiber/fiberref.md b/docs/reference/fiber/fiberref.md similarity index 100% rename from docs/references/fiber/fiberref.md rename to docs/reference/fiber/fiberref.md diff --git a/docs/references/fiber/fiberstatus.md b/docs/reference/fiber/fiberstatus.md similarity index 100% rename from docs/references/fiber/fiberstatus.md rename to docs/reference/fiber/fiberstatus.md diff --git a/docs/references/fiber/index.md b/docs/reference/fiber/index.md similarity index 100% rename from docs/references/fiber/index.md rename to docs/reference/fiber/index.md diff --git a/docs/references/index.md b/docs/reference/index.md similarity index 100% rename from docs/references/index.md rename to docs/reference/index.md diff --git a/docs/references/metrics/counter.md b/docs/reference/metrics/counter.md similarity index 100% rename from docs/references/metrics/counter.md rename to docs/reference/metrics/counter.md diff --git a/docs/references/metrics/gauge.md b/docs/reference/metrics/gauge.md similarity index 100% rename from docs/references/metrics/gauge.md rename to docs/reference/metrics/gauge.md diff --git a/docs/references/metrics/histogram.md b/docs/reference/metrics/histogram.md similarity index 100% rename from docs/references/metrics/histogram.md rename to docs/reference/metrics/histogram.md diff --git a/docs/references/metrics/index.md b/docs/reference/metrics/index.md similarity index 100% rename from docs/references/metrics/index.md rename to docs/reference/metrics/index.md diff --git a/docs/references/metrics/jvm.md b/docs/reference/metrics/jvm.md similarity index 100% rename from docs/references/metrics/jvm.md rename to docs/reference/metrics/jvm.md diff --git a/docs/references/metrics/metriclabel.md b/docs/reference/metrics/metriclabel.md similarity index 100% rename from docs/references/metrics/metriclabel.md rename to docs/reference/metrics/metriclabel.md diff --git a/docs/references/metrics/setcount.md b/docs/reference/metrics/setcount.md similarity index 100% rename from docs/references/metrics/setcount.md rename to docs/reference/metrics/setcount.md diff --git a/docs/references/metrics/summary.md b/docs/reference/metrics/summary.md similarity index 100% rename from docs/references/metrics/summary.md rename to docs/reference/metrics/summary.md diff --git a/docs/references/misc/chunk.md b/docs/reference/misc/chunk.md similarity index 100% rename from docs/references/misc/chunk.md rename to docs/reference/misc/chunk.md diff --git a/docs/references/misc/schedule.md b/docs/reference/misc/schedule.md similarity index 100% rename from docs/references/misc/schedule.md rename to docs/reference/misc/schedule.md diff --git a/docs/references/misc/supervisor.md b/docs/reference/misc/supervisor.md similarity index 100% rename from docs/references/misc/supervisor.md rename to docs/reference/misc/supervisor.md diff --git a/docs/references/misc/zstate.md b/docs/reference/misc/zstate.md similarity index 100% rename from docs/references/misc/zstate.md rename to docs/reference/misc/zstate.md diff --git a/docs/references/resource/index.md b/docs/reference/resource/index.md similarity index 100% rename from docs/references/resource/index.md rename to docs/reference/resource/index.md diff --git a/docs/references/resource/scope.md b/docs/reference/resource/scope.md similarity index 100% rename from docs/references/resource/scope.md rename to docs/reference/resource/scope.md diff --git a/docs/references/resource/zpool.md b/docs/reference/resource/zpool.md similarity index 100% rename from docs/references/resource/zpool.md rename to docs/reference/resource/zpool.md diff --git a/docs/references/stm/index.md b/docs/reference/stm/index.md similarity index 100% rename from docs/references/stm/index.md rename to docs/reference/stm/index.md diff --git a/docs/references/stm/stm.md b/docs/reference/stm/stm.md similarity index 100% rename from docs/references/stm/stm.md rename to docs/reference/stm/stm.md diff --git a/docs/references/stm/tarray.md b/docs/reference/stm/tarray.md similarity index 100% rename from docs/references/stm/tarray.md rename to docs/reference/stm/tarray.md diff --git a/docs/references/stm/thub.md b/docs/reference/stm/thub.md similarity index 100% rename from docs/references/stm/thub.md rename to docs/reference/stm/thub.md diff --git a/docs/references/stm/tmap.md b/docs/reference/stm/tmap.md similarity index 100% rename from docs/references/stm/tmap.md rename to docs/reference/stm/tmap.md diff --git a/docs/references/stm/tpriorityqueue.md b/docs/reference/stm/tpriorityqueue.md similarity index 100% rename from docs/references/stm/tpriorityqueue.md rename to docs/reference/stm/tpriorityqueue.md diff --git a/docs/references/stm/tpromise.md b/docs/reference/stm/tpromise.md similarity index 100% rename from docs/references/stm/tpromise.md rename to docs/reference/stm/tpromise.md diff --git a/docs/references/stm/tqueue.md b/docs/reference/stm/tqueue.md similarity index 100% rename from docs/references/stm/tqueue.md rename to docs/reference/stm/tqueue.md diff --git a/docs/references/stm/trandom.md b/docs/reference/stm/trandom.md similarity index 100% rename from docs/references/stm/trandom.md rename to docs/reference/stm/trandom.md diff --git a/docs/references/stm/treentrantlock.md b/docs/reference/stm/treentrantlock.md similarity index 100% rename from docs/references/stm/treentrantlock.md rename to docs/reference/stm/treentrantlock.md diff --git a/docs/references/stm/tref.md b/docs/reference/stm/tref.md similarity index 100% rename from docs/references/stm/tref.md rename to docs/reference/stm/tref.md diff --git a/docs/references/stm/tsemaphore.md b/docs/reference/stm/tsemaphore.md similarity index 100% rename from docs/references/stm/tsemaphore.md rename to docs/reference/stm/tsemaphore.md diff --git a/docs/references/stm/tset.md b/docs/reference/stm/tset.md similarity index 100% rename from docs/references/stm/tset.md rename to docs/reference/stm/tset.md diff --git a/docs/references/stream/index.md b/docs/reference/stream/index.md similarity index 100% rename from docs/references/stream/index.md rename to docs/reference/stream/index.md diff --git a/docs/references/stream/sink.md b/docs/reference/stream/sink.md similarity index 100% rename from docs/references/stream/sink.md rename to docs/reference/stream/sink.md diff --git a/docs/references/stream/stream.md b/docs/reference/stream/stream.md similarity index 100% rename from docs/references/stream/stream.md rename to docs/reference/stream/stream.md diff --git a/docs/references/stream/subscriptionref.md b/docs/reference/stream/subscriptionref.md similarity index 100% rename from docs/references/stream/subscriptionref.md rename to docs/reference/stream/subscriptionref.md diff --git a/docs/references/stream/ustream.md b/docs/reference/stream/ustream.md similarity index 100% rename from docs/references/stream/ustream.md rename to docs/reference/stream/ustream.md diff --git a/docs/references/stream/zchannel.md b/docs/reference/stream/zchannel.md similarity index 100% rename from docs/references/stream/zchannel.md rename to docs/reference/stream/zchannel.md diff --git a/docs/references/stream/zpipeline.md b/docs/reference/stream/zpipeline.md similarity index 100% rename from docs/references/stream/zpipeline.md rename to docs/reference/stream/zpipeline.md diff --git a/docs/references/stream/zsink.md b/docs/reference/stream/zsink.md similarity index 100% rename from docs/references/stream/zsink.md rename to docs/reference/stream/zsink.md diff --git a/docs/references/stream/zstream.md b/docs/reference/stream/zstream.md similarity index 100% rename from docs/references/stream/zstream.md rename to docs/reference/stream/zstream.md diff --git a/docs/references/sync/concurrentmap.md b/docs/reference/sync/concurrentmap.md similarity index 100% rename from docs/references/sync/concurrentmap.md rename to docs/reference/sync/concurrentmap.md diff --git a/docs/references/sync/concurrentset.md b/docs/reference/sync/concurrentset.md similarity index 100% rename from docs/references/sync/concurrentset.md rename to docs/reference/sync/concurrentset.md diff --git a/docs/references/sync/countdownlatch.md b/docs/reference/sync/countdownlatch.md similarity index 100% rename from docs/references/sync/countdownlatch.md rename to docs/reference/sync/countdownlatch.md diff --git a/docs/references/sync/cyclicbarrier.md b/docs/reference/sync/cyclicbarrier.md similarity index 100% rename from docs/references/sync/cyclicbarrier.md rename to docs/reference/sync/cyclicbarrier.md diff --git a/docs/references/sync/index.md b/docs/reference/sync/index.md similarity index 100% rename from docs/references/sync/index.md rename to docs/reference/sync/index.md diff --git a/docs/references/sync/mvar.md b/docs/reference/sync/mvar.md similarity index 100% rename from docs/references/sync/mvar.md rename to docs/reference/sync/mvar.md diff --git a/docs/references/sync/reentrantlock.md b/docs/reference/sync/reentrantlock.md similarity index 100% rename from docs/references/sync/reentrantlock.md rename to docs/reference/sync/reentrantlock.md diff --git a/docs/references/test/assertion.md b/docs/reference/test/assertion.md similarity index 100% rename from docs/references/test/assertion.md rename to docs/reference/test/assertion.md diff --git a/docs/references/test/environment/clock.md b/docs/reference/test/environment/clock.md similarity index 100% rename from docs/references/test/environment/clock.md rename to docs/reference/test/environment/clock.md diff --git a/docs/references/test/environment/console.md b/docs/reference/test/environment/console.md similarity index 100% rename from docs/references/test/environment/console.md rename to docs/reference/test/environment/console.md diff --git a/docs/references/test/environment/index.md b/docs/reference/test/environment/index.md similarity index 100% rename from docs/references/test/environment/index.md rename to docs/reference/test/environment/index.md diff --git a/docs/references/test/environment/live.md b/docs/reference/test/environment/live.md similarity index 100% rename from docs/references/test/environment/live.md rename to docs/reference/test/environment/live.md diff --git a/docs/references/test/environment/random.md b/docs/reference/test/environment/random.md similarity index 100% rename from docs/references/test/environment/random.md rename to docs/reference/test/environment/random.md diff --git a/docs/references/test/environment/sized.md b/docs/reference/test/environment/sized.md similarity index 100% rename from docs/references/test/environment/sized.md rename to docs/reference/test/environment/sized.md diff --git a/docs/references/test/environment/system.md b/docs/reference/test/environment/system.md similarity index 100% rename from docs/references/test/environment/system.md rename to docs/reference/test/environment/system.md diff --git a/docs/references/test/environment/test-config.md b/docs/reference/test/environment/test-config.md similarity index 100% rename from docs/references/test/environment/test-config.md rename to docs/reference/test/environment/test-config.md diff --git a/docs/references/test/gen.md b/docs/reference/test/gen.md similarity index 100% rename from docs/references/test/gen.md rename to docs/reference/test/gen.md diff --git a/docs/references/test/index.md b/docs/reference/test/index.md similarity index 100% rename from docs/references/test/index.md rename to docs/reference/test/index.md diff --git a/docs/references/test/spec.md b/docs/reference/test/spec.md similarity index 100% rename from docs/references/test/spec.md rename to docs/reference/test/spec.md diff --git a/docs/references/test/test-aspect.md b/docs/reference/test/test-aspect.md similarity index 100% rename from docs/references/test/test-aspect.md rename to docs/reference/test/test-aspect.md diff --git a/docs/resources/ecosystem/officials/zio-mock.md b/docs/resources/ecosystem/officials/zio-mock.md index 13f377b71d2f..bb468e20df20 100644 --- a/docs/resources/ecosystem/officials/zio-mock.md +++ b/docs/resources/ecosystem/officials/zio-mock.md @@ -650,7 +650,7 @@ We can find more examples in the `examples` and `test-tests` subproject: - [ComposedEmptyMockSpec][link-gh-composed-empty-mock-spec] - [PolyMockSpec][link-gh-poly-mock-spec] -[doc-contextual-types]: ../../../references/contextual/index.md +[doc-contextual-types]: ../../../reference/contextual/index.md [link-sls-6.26.1]: https://scala-lang.org/files/archive/spec/2.13/06-expressions.html#value-conversions [link-test-doubles]: https://martinfowler.com/articles/mocksArentStubs.html [link-gh-mock-example-spec]: https://github.com/zio/zio/blob/master/examples/shared/src/test/scala/zio/examples/test/MockExampleSpec.scala diff --git a/internal-macros/shared/src/main/scala/zio/internal/TerminalRendering.scala b/internal-macros/shared/src/main/scala/zio/internal/TerminalRendering.scala index 5147a231c514..840e71d891ef 100644 --- a/internal-macros/shared/src/main/scala/zio/internal/TerminalRendering.scala +++ b/internal-macros/shared/src/main/scala/zio/internal/TerminalRendering.scala @@ -132,7 +132,7 @@ object TerminalRendering { | Call your $effectType's ${"provide".green.bold} method with the layers you need. | You can read more about layers and providing services here: | - | https://zio.dev/next/references/contextual/ + | https://zio.dev/next/reference/contextual/ | |${line.red} | diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index bd26f9ac0b31..d460f6339cd2 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -28,7 +28,7 @@ const config = { }, items: [ { type: 'docsVersion', label: 'Overview', position: 'right' }, - { type: 'doc', docId: 'references/index', label: 'References', position: 'right' }, + { type: 'doc', docId: 'reference/index', label: 'Reference', position: 'right' }, { type: 'doc', docId: 'guides/index', label: 'Guides', position: 'right' }, { type: 'doc', docId: 'resources/index', label: 'Resources', position: 'right' }, { type: 'doc', docId: 'about/about_index', label: 'About', position: 'right' }, diff --git a/website/sidebars.js b/website/sidebars.js index f5bb5fa4025f..0bd06b90ae92 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -11,8 +11,8 @@ module.exports = { "overview/overview_performance", "overview/overview_platforms" ], - "references-sidebar": [ - "references/index", + "reference-sidebar": [ + "reference/index", { type: "category", label: "Core Data Types", @@ -20,7 +20,7 @@ module.exports = { items: [ { type: "category", - link: { type: 'doc', id: 'references/core/zio/zio' }, + link: { type: 'doc', id: 'reference/core/zio/zio' }, label: "ZIO", items: [ { @@ -28,20 +28,20 @@ module.exports = { collapsed: true, label: "Type Aliases", items: [ - "references/core/zio/uio", - "references/core/zio/urio", - "references/core/zio/task", - "references/core/zio/rio", - "references/core/zio/io", + "reference/core/zio/uio", + "reference/core/zio/urio", + "reference/core/zio/task", + "reference/core/zio/rio", + "reference/core/zio/io", ] }, - "references/core/zio/error-management", + "reference/core/zio/error-management", ] }, - "references/core/zioapp", - "references/core/runtime", - "references/core/exit", - "references/core/cause" + "reference/core/zioapp", + "reference/core/runtime", + "reference/core/exit", + "reference/core/cause" ] }, { @@ -49,29 +49,29 @@ module.exports = { label: "Contextual Types", items: [ - "references/contextual/index", - "references/contextual/zenvironment", + "reference/contextual/index", + "reference/contextual/zenvironment", { type: "category", label: "ZIO Layers", items: [ - "references/contextual/zlayer", - "references/contextual/rlayer", - "references/contextual/ulayer", - "references/contextual/layer", - "references/contextual/urlayer", - "references/contextual/tasklayer" + "reference/contextual/zlayer", + "reference/contextual/rlayer", + "reference/contextual/ulayer", + "reference/contextual/layer", + "reference/contextual/urlayer", + "reference/contextual/tasklayer" ] }, { type: "category", label: "Built-in Services", items: [ - "references/contextual/services/index", - "references/contextual/services/console", - "references/contextual/services/clock", - "references/contextual/services/random", - "references/contextual/services/system" + "reference/contextual/services/index", + "reference/contextual/services/console", + "reference/contextual/services/clock", + "reference/contextual/services/random", + "reference/contextual/services/system" ] } ] @@ -84,61 +84,61 @@ module.exports = { type: "category", label: "ZIO Fibers", items: [ - "references/fiber/index", - "references/fiber/fiber", - "references/fiber/fiberref", - "references/fiber/fiberid", - "references/fiber/fiberstatus" + "reference/fiber/index", + "reference/fiber/fiber", + "reference/fiber/fiberref", + "reference/fiber/fiberid", + "reference/fiber/fiberstatus" ] }, { type: "category", label: "Synchronization", items: [ - "references/sync/index", - "references/sync/reentrantlock", - "references/sync/countdownlatch", - "references/sync/cyclicbarrier", - "references/sync/concurrentmap", - "references/sync/concurrentset", + "reference/sync/index", + "reference/sync/reentrantlock", + "reference/sync/countdownlatch", + "reference/sync/cyclicbarrier", + "reference/sync/concurrentmap", + "reference/sync/concurrentset", ] }, { type: "category", label: "Concurrency Primitives", items: [ - "references/concurrency/index", + "reference/concurrency/index", { type: "category", - label: "Mutable References", + label: "Mutable Reference", items: [ - "references/concurrency/ref", - "references/concurrency/refsynchronized", + "reference/concurrency/ref", + "reference/concurrency/refsynchronized", ] }, - "references/concurrency/promise", - "references/concurrency/queue", - "references/concurrency/hub", - "references/concurrency/semaphore" + "reference/concurrency/promise", + "reference/concurrency/queue", + "reference/concurrency/hub", + "reference/concurrency/semaphore" ] }, { type: "category", label: "STM", items: [ - "references/stm/index", - "references/stm/stm", - "references/stm/tarray", - "references/stm/trandom", - "references/stm/tset", - "references/stm/tmap", - "references/stm/tref", - "references/stm/tpriorityqueue", - "references/stm/tpromise", - "references/stm/tqueue", - "references/stm/treentrantlock", - "references/stm/tsemaphore", - "references/stm/thub", + "reference/stm/index", + "reference/stm/stm", + "reference/stm/tarray", + "reference/stm/trandom", + "reference/stm/tset", + "reference/stm/tmap", + "reference/stm/tref", + "reference/stm/tpriorityqueue", + "reference/stm/tpromise", + "reference/stm/tqueue", + "reference/stm/treentrantlock", + "reference/stm/tsemaphore", + "reference/stm/thub", ] }, ] @@ -147,16 +147,16 @@ module.exports = { type: "category", label: "Resource Management", items: [ - "references/resource/index", - "references/resource/scope", - "references/resource/zpool", + "reference/resource/index", + "reference/resource/scope", + "reference/resource/zpool", ] }, { type: "category", label: "Streaming", items: [ - "references/stream/index", + "reference/stream/index", { type: "category", label: "Main Components", @@ -165,85 +165,85 @@ module.exports = { type: "category", label: "ZStream", items: [ - "references/stream/zstream", - "references/stream/stream", - "references/stream/ustream", + "reference/stream/zstream", + "reference/stream/stream", + "reference/stream/ustream", ] }, { type: "category", label: "ZPipeline", items: [ - "references/stream/zpipeline", + "reference/stream/zpipeline", ] }, { type: "category", label: "ZSink", items: [ - "references/stream/zsink", - "references/stream/sink", + "reference/stream/zsink", + "reference/stream/sink", ] }, - "references/stream/zchannel" + "reference/stream/zchannel" ] }, - "references/stream/subscription-ref" + "reference/stream/subscription-ref" ] }, { type: "category", label: "Metrics", items: [ - "references/metrics/index", + "reference/metrics/index", { type: "category", label: "Metric Types", items: [ - "references/metrics/counter", - "references/metrics/gauge", - "references/metrics/histogram", - "references/metrics/summary", - "references/metrics/setcount" + "reference/metrics/counter", + "reference/metrics/gauge", + "reference/metrics/histogram", + "reference/metrics/summary", + "reference/metrics/setcount" ] }, - "references/metrics/metriclabel", - "references/metrics/jvm", + "reference/metrics/metriclabel", + "reference/metrics/jvm", ] }, { type: "category", label: "Testing", items: [ - "references/test/index", - "references/test/spec", - "references/test/assertion", + "reference/test/index", + "reference/test/spec", + "reference/test/assertion", { type: "category", label: "Test Services", items: [ - "references/test/environment/index", - "references/test/environment/console", - "references/test/environment/clock", - "references/test/environment/random", - "references/test/environment/system", - "references/test/environment/live", - "references/test/environment/config", - "references/test/environment/sized", + "reference/test/environment/index", + "reference/test/environment/console", + "reference/test/environment/clock", + "reference/test/environment/random", + "reference/test/environment/system", + "reference/test/environment/live", + "reference/test/environment/config", + "reference/test/environment/sized", ] }, - "references/test/test-aspect", - "references/test/gen", + "reference/test/test-aspect", + "reference/test/gen", ] }, { type: "category", label: "Miscellaneous", items: [ - "references/misc/chunk", - "references/misc/schedule", - "references/misc/supervisor", - "references/misc/zstate", + "reference/misc/chunk", + "reference/misc/schedule", + "reference/misc/supervisor", + "reference/misc/zstate", ] } ], diff --git a/website/version2-only-docusaurus.config.js b/website/version2-only-docusaurus.config.js index dc24ba12ab95..60fa0db840eb 100644 --- a/website/version2-only-docusaurus.config.js +++ b/website/version2-only-docusaurus.config.js @@ -28,7 +28,7 @@ module.exports = { }, items: [ { to: 'overview/index', label: 'Overview', position: 'right' }, - { to: 'references/index', label: 'References', position: 'right' }, + { to: 'reference/index', label: 'Reference', position: 'right' }, { to: 'guides/index', label: 'Guides', position: 'right' }, { to: 'resources/index', label: 'Resources', position: 'right' }, { to: 'about/index', label: 'About', position: 'right' }, From 5df1a87f8321c6d0f06f62dccb0cce6368fbfcfa Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 20:07:25 +0430 Subject: [PATCH 10/15] add index page for the ecosystem section. --- docs/resources/ecosystem/tools.md | 2 +- docs/resources/index.md | 82 ++++++++++++++++++++++++++++++- 2 files changed, 82 insertions(+), 2 deletions(-) diff --git a/docs/resources/ecosystem/tools.md b/docs/resources/ecosystem/tools.md index 6268b5cd9cbd..dca56e2727a2 100644 --- a/docs/resources/ecosystem/tools.md +++ b/docs/resources/ecosystem/tools.md @@ -1,6 +1,6 @@ --- id: tools -title: "Tools for ZIO" +title: "ZIO Tools" --- - [ZIO IntelliJ](https://github.com/zio/zio-intellij) — A complimentary, community-developed plugin for IntelliJ IDEA, brings enhancements when using ZIO in your projects diff --git a/docs/resources/index.md b/docs/resources/index.md index 55ad9e139671..3b0f8debd35d 100644 --- a/docs/resources/index.md +++ b/docs/resources/index.md @@ -3,4 +3,84 @@ id: index title: "Summary" --- -If you find a new great library, talk, resource, slides or project, related to ZIO, consider adding to the list with your PR +ZIO has a huge ecosystem of libraries, tools, talks, tutorials, and more. In this section, we are going to introduce some of the most important ones. + +> **Note:** +> +> If you find a new great library, talk, resource, slides, or project, related to ZIO, consider adding it to the list with your PR. + +## Learning ZIO + +* [Articles](learning/articles.md) +* [Videos](learning/videos.md) +* [Cookbooks](learning/cookbooks.md) +* [Cheat Sheets](learning/cheatsheets.md) +* [Sample Projects](learning/sampleprojects.md) +* [Projects Using ZIO](learning/projectsusingzio.md) + +## ZIO Ecosystem + +We have two categories of libraries: official and community. + +### Official Libraries + +Official libraries are maintained by the ZIO team under the [ZIO Organization](https://github.com/zio). + +* [ZIO Actors](ecosystem/officials/zio-actors.md) +* [ZIO Akka Cluster](ecosystem/officials/zio-akka-cluster.md) +* [ZIO AWS](ecosystem/officials/zio-aws.md) +* [ZIO Cache](ecosystem/officials/zio-cache.md) +* [ZIO Config](ecosystem/officials/zio-config.md) +* [ZIO FTP](ecosystem/officials/zio-ftp.md) +* [ZIO JSON](ecosystem/officials/zio-json.md) +* [ZIO Kafka](ecosystem/officials/zio-kafka.md) +* [ZIO Logging](ecosystem/officials/zio-logging.md) +* [ZIO Metrics](ecosystem/officials/zio-metrics.md) +* [ZIO Mock](ecosystem/officials/zio-mock.md) +* [ZIO NIO](ecosystem/officials/zio-nio.md) +* [ZIO Optics](ecosystem/officials/zio-optics.md) +* [ZIO Prelude](ecosystem/officials/zio-prelude.md) +* [ZIO Process](ecosystem/officials/zio-process.md) +* [ZIO Query](ecosystem/officials/zio-query.md) +* [ZIO Redis](ecosystem/officials/zio-redis.md) +* [ZIO RocksDB](ecosystem/officials/zio-rocksdb.md) +* [ZIO S3](ecosystem/officials/zio-s3.md) +* [ZIO Schema](ecosystem/officials/zio-schema.md) +* [ZIO SQS](ecosystem/officials/zio-sqs.md) +* [ZIO Telemetry](ecosystem/officials/zio-telemetry.md) +* [ZIO ZMX](ecosystem/officials/zio-zmx.md) + +### Community Libraries + +* [Caliban](ecosystem/community/caliban.md) +* [Distage](ecosystem/community/distage.md) +* [LogStage](ecosystem/community/logstage.md) +* [MUnit ZIO](ecosystem/community/munit-zio.md) +* [Quill](ecosystem/community/quill.md) +* [Rezilience](ecosystem/community/rezilience.md) +* [tamer](ecosystem/community/tamer.md) +* [TranzactIO](ecosystem/community/tranzactio.md) +* [ZIO AMQP](ecosystem/community/zio-amqp.md) +* [ZIO Arrow](ecosystem/community/zio-arrow.md) +* [ZIO AWS S3](ecosystem/community/zio-aws-s3.md) +* [ZIO gRPC](ecosystem/community/zio-grpc.md) +* [ZIO HTTP](ecosystem/community/zio-http.md) +* [ZIO K8S](ecosystem/community/zio-k8s.md) +* [ZIO Kinesis](ecosystem/community/zio-kinesis.md) +* [ZIO Pulsar](ecosystem/community/zio-pulsar.md) +* [ZIO Saga](ecosystem/community/zio-saga.md) +* [ZIO Slick Interop](ecosystem/community/zio-slick-interop.md) +* [ZIO Test Akka HTTP](ecosystem/community/zio-test-akka-http.md) + +## ZIO Compatible Libraries + +To learn about ZIO compatible libraries, see [this section](ecosystem/compatible.md). + +## ZIO Tools + +To learn about tools that are useful for ZIO development, see [this section](ecosystem/tools.md). + +## Project Templates + +In this section, we introduce a list of [project templates](ecosystem/templates.md) that can be used to quickly start a new project. + From 16d493d66b6f427aefb8efe0ccf4148fcac3f4c7 Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 20:37:40 +0430 Subject: [PATCH 11/15] link each category to it's index page. --- website/sidebars.js | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 0bd06b90ae92..b64546a4135a 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -47,27 +47,34 @@ module.exports = { { type: "category", label: "Contextual Types", + link: { type: "doc", id: "reference/contextual/index" }, items: [ - "reference/contextual/index", "reference/contextual/zenvironment", { type: "category", label: "ZIO Layers", items: [ "reference/contextual/zlayer", - "reference/contextual/rlayer", - "reference/contextual/ulayer", - "reference/contextual/layer", - "reference/contextual/urlayer", - "reference/contextual/tasklayer" + { + type: "category", + collapsed: true, + label: "Type Aliases", + items: [ + "reference/contextual/rlayer", + "reference/contextual/ulayer", + "reference/contextual/layer", + "reference/contextual/urlayer", + "reference/contextual/tasklayer" + ] + } ] }, { type: "category", label: "Built-in Services", + link: { type: "doc", id: "reference/contextual/services/index" }, items: [ - "reference/contextual/services/index", "reference/contextual/services/console", "reference/contextual/services/clock", "reference/contextual/services/random", @@ -83,8 +90,8 @@ module.exports = { { type: "category", label: "ZIO Fibers", + link: { type: "doc", id: "reference/fiber/index" }, items: [ - "reference/fiber/index", "reference/fiber/fiber", "reference/fiber/fiberref", "reference/fiber/fiberid", @@ -94,8 +101,8 @@ module.exports = { { type: "category", label: "Synchronization", + link: { type: "doc", id: "reference/sync/index" }, items: [ - "reference/sync/index", "reference/sync/reentrantlock", "reference/sync/countdownlatch", "reference/sync/cyclicbarrier", @@ -106,8 +113,8 @@ module.exports = { { type: "category", label: "Concurrency Primitives", + link: { type: "doc", id: "reference/concurrency/index" }, items: [ - "reference/concurrency/index", { type: "category", label: "Mutable Reference", @@ -125,8 +132,8 @@ module.exports = { { type: "category", label: "STM", + link: { type: "doc", id: "reference/stm/index" }, items: [ - "reference/stm/index", "reference/stm/stm", "reference/stm/tarray", "reference/stm/trandom", @@ -146,8 +153,8 @@ module.exports = { { type: "category", label: "Resource Management", + link: { type: "doc", id: "reference/resource/index" }, items: [ - "reference/resource/index", "reference/resource/scope", "reference/resource/zpool", ] @@ -155,8 +162,8 @@ module.exports = { { type: "category", label: "Streaming", + link: { type: "doc", id: "reference/stream/index" }, items: [ - "reference/stream/index", { type: "category", label: "Main Components", @@ -194,8 +201,8 @@ module.exports = { { type: "category", label: "Metrics", + link: { type: "doc", id: "reference/metrics/index" }, items: [ - "reference/metrics/index", { type: "category", label: "Metric Types", @@ -214,15 +221,15 @@ module.exports = { { type: "category", label: "Testing", + link: { type: "doc", id: "reference/test/index" }, items: [ - "reference/test/index", "reference/test/spec", "reference/test/assertion", { type: "category", label: "Test Services", + link: { type: "doc", id: "reference/test/environment/index" }, items: [ - "reference/test/environment/index", "reference/test/environment/console", "reference/test/environment/clock", "reference/test/environment/random", From 24292a98a0fae6e382b1caf475c736026e3474ad Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 20:41:26 +0430 Subject: [PATCH 12/15] rename the "core data types" section to "core." --- website/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/sidebars.js b/website/sidebars.js index b64546a4135a..ed1a366bf686 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -15,7 +15,7 @@ module.exports = { "reference/index", { type: "category", - label: "Core Data Types", + label: "Core", collapsed: false, items: [ { From 18c99805da52733ae08d028888d836861eef2af9 Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 20:42:05 +0430 Subject: [PATCH 13/15] remvoe the extra introduction header. --- docs/reference/stream/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/reference/stream/index.md b/docs/reference/stream/index.md index bb090252aac4..d40ce5bd702d 100644 --- a/docs/reference/stream/index.md +++ b/docs/reference/stream/index.md @@ -12,8 +12,6 @@ import zio.Console._ import java.io.IOException ``` -## Introduction - The primary goal of a streaming library is to introduce **a high-level API that abstracts the mechanism of reading and writing operations using data sources and destinations**. A streaming library helps us to concentrate on the business logic and separates us from low-level implementation details. From 32abbd18869f6b9a18190570bdd01e9aa40b7698 Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Fri, 22 Jul 2022 21:02:47 +0430 Subject: [PATCH 14/15] auto-collapse categories. --- website/docusaurus.config.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index d460f6339cd2..181477a8c566 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -9,6 +9,11 @@ const config = { organizationName: 'zio', projectName: 'zio', themeConfig: { + docs: { + sidebar: { + autoCollapseCategories: true, + }, + }, prism: { // In case we want to use one of the json packaged themes, we can simply require those //theme: require('prism-react-renderer/themes/vsDark'), From bef7c36f7645057886882d73c4accd82fd86d4cf Mon Sep 17 00:00:00 2001 From: Milad Khajavi Date: Sat, 23 Jul 2022 15:52:03 +0430 Subject: [PATCH 15/15] remove extra titles. --- docs/guides/index.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index 38283b23c53c..2d0887322ab0 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -12,9 +12,6 @@ The following guides have been written to help you get started with ZIO with min 2. [ZIO Quickstart: Building a RESTful Web Service](quickstarts/restful-webservice.md) 3. [ZIO Quickstart: Building a GraphQL Web Service](quickstarts/graphql-webservice.md) 4. [ZIO Quickstart: Building a gRPC Server and Client](https://scalapb.github.io/zio-grpc/docs/quickstart/) -5. Getting Started With ZIO Streaming -6. Getting Started With ZIO and ScalaJS -7. Getting Started with a ZIO Application With a Persistent Layer ## Tutorial Guides @@ -29,13 +26,6 @@ The following guides have been written to help you get started with ZIO with min 9. [How to Monitor a ZIO Application Using ZIO's Built-in Metric System?](tutorials/monitor-a-zio-application-using-zios-built-in-metric-system.md) 10. [How to Produce/Consume Data To/From Kafka Topics?](tutorials/produce-consume-data-to-from-kafka-topics.md) 11. [How to Debug a ZIO Application?](tutorials/debug-a-zio-application.md) -12. Building a Web Service Client -13. Building a gRPC Service with its Client -14. How to Build a Chat Client and Server using ZIO Streams? -15. How to Monitor a ZIO Application by Implementing Custom Metrics -16. How to Integrate ZIO With a Legacy JVM Application? -17. How to Consume/Produce Data From/To a RabbitMQ Queue? -18. How to Enable Tracing in ZIO and How to Use it? ## Integration Guides