10000 Documentation: Reorganize Sidebars by khajavi · Pull Request #7113 · zio/zio · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Documentation: Reorganize Sidebars #7113

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

Merged
merged 15 commits into from
Jul 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 0 additions & 10 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/guides/migrate/from-cats-effect.md
Original file line number Diff line number Diff line change
@@ -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]`).
Expand Down
1 change: 1 addition & 0 deletions docs/guides/migrate/from-monix.md
Original file line number Diff line number Diff line change
@@ -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]`).
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/migrate/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/handling_errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
17 changes: 17 additions & 0 deletions docs/reference/core/index.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/resources/ecosystem/officials/zio-mock.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/ecosystem/tools.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
82 changes: 81 additions & 1 deletion docs/resources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

E1E9
Original file line number Diff line number Diff line change
Expand Up @@ -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}
|
Expand Down
7 changes: 6 additions & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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'),
Expand All @@ -28,7 +33,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' },
Expand Down
Loading
0