Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Website: Enrich Footer Section #7961

Merged
merged 1 commit into from
Mar 29, 2023
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Powered by highly-scalable, non-blocking fibers that never waste or leak resourc
To learn more about ZIO, see the following references:

- [Homepage](https://zio.dev/)
- [Contributor's Guide](./docs/about/contributing.md)
- [Contributor's Guide](docs/about/contributing.md)
- [License](LICENSE)
- [Issues](https://github.com/zio/zio/issues)
- [Pull Requests](https://github.com/zio/zio/pulls)
Expand Down Expand Up @@ -206,7 +206,7 @@ Want to see your company here? [Submit a PR](https://github.com/zio/zio/edit/mas

## Code of Conduct

See the [Code of Conduct](./docs/about/code-of-conduct.md)
See the [Code of Conduct](docs/code-of-conduct.md)

---

Expand Down
9 changes: 0 additions & 9 deletions docs/about/index.md

This file was deleted.

7 changes: 4 additions & 3 deletions docs/about/users.md → docs/adopters.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
id: users
title: "ZIO Users"
id: adopters
slug: adopters
title: "ZIO Adopters"
---

Following is a partial list of companies happily using ZIO in production to craft concurrent applications.

Want to see your company here? [Submit a PR](https://github.com/zio/zio/edit/series/2.x/docs/about/users.md)!
Want to see your company here? [Submit a PR](https://github.com/zio/zio/edit/series/2.x/docs/adopters.md)!


| Company | Logo |
Expand Down
3 changes: 2 additions & 1 deletion docs/about/code-of-conduct.md → docs/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: code-of-conduct
title: "ZIO Code of Conduct"
slug: code-of-conduct
title: "Code of Conduct"
---

We are committed to providing a friendly, safe and welcoming
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: coding-guidelines
title: "ZIO Coding Guidelines"
slug: coding-guidelines
title: "Coding Guidelines"
---

These are coding guidelines strictly for ZIO contributors for ZIO projects and
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
id: contributing-to-documentation
slug: contributing-to-documentation
title: "Contributing to The ZIO Documentation"
---

Expand Down
5 changes: 3 additions & 2 deletions docs/about/contributing.md → docs/contributor-guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: contributing
title: "ZIO Contributor Guidelines"
id: contributor-guidelines
slug: contributor-guidelines
title: "Contributor Guidelines"
---

Thank you for your interest in contributing to ZIO, which is a small, zero-dependency library for doing type-safe, composable concurrent and asynchronous programming!
Expand Down
3 changes: 2 additions & 1 deletion docs/about/faq.md → docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
id: faq
slug: faq
title: "Frequently Answered Questions (FAQ)"
sidebar_label: "FAQ"
---
Expand All @@ -13,7 +14,7 @@ In this page we are going to answer general questions related to the ZIO project
3. Should we keep writing our effects with explicit params as `def someEffect(c: CorrelationId, u: UserId, params...): ZIO[Any, ErrorType, A]`?
4. Should we put these context parameters as implicits, like `def someEffect(params..)(implicit c: CorrelationId, u: UserId): ZIO[Any, ErrorType, A]`?

Before answering these question, make sure you have read the [ZIO Environment Use-cases](../reference/contextual/index.md) section.
Before answering these question, make sure you have read the [ZIO Environment Use-cases](reference/contextual/index.md) section.

Now, let's go into this in a little more detail. We have some workflow, `someEffect` that conceptually requires both a `CorrelationId` and a `UserId` to be run. Let's consider any of these solutions in turn.

Expand Down
83 changes: 52 additions & 31 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ const config = {
{ type: 'doc', docId: 'ecosystem/index', label: 'Ecosystem', position: 'left' },
{ type: 'doc', docId: 'resources/index', label: 'Resources', position: 'left' },
{ type: 'doc', docId: 'events/index', label: 'Events', position: 'left' },
{ type: 'doc', docId: 'about/index', label: 'About', position: 'right' },
{ to: 'blog', label: 'Blog', position: 'right' },
{
type: 'docsVersionDropdown',
Expand All @@ -67,35 +66,40 @@ const config = {
footer: {
style: 'dark', links: [
{
title: 'Learn!',
items: [
{
html: `
<img src="/img/navbar_brand.png" alt="zio" />
`
}
],
},
{
title: 'Github',
items: [
label: 'Getting Started!',
href: '/overview/getting-started'
},
{
html: `
<a href="https://github.com/zio/zio">
<img src="https://img.shields.io/github/stars/zio/zio?style=social" alt="github" />
</a>
`
label: 'Reference',
href: '/reference'
},
{
label: 'Guides',
href: '/guides'
},
{
label: 'Scaladoc of ZIO',
href: 'https://javadoc.io/doc/dev.zio/zio_3/latest/index.html'
}
],
},
{
title: 'Discord',
title: 'Community and Social',
items: [
{
html: `
<a href="https://discord.gg/2ccFBr4">
<img src="https://img.shields.io/discord/629491597070827530?logo=discord&style=social" alt="discord"/>
</a>
`
label: 'Github',
href: 'https://github.com/zio/zio'
},
{
label: 'Discord',
href: 'https://discord.gg/2ccFBr4'
},
{
label: 'Twitter',
href: "https://twitter.com/zioscala"
}
],
},
Expand All @@ -110,23 +114,40 @@ const config = {
],
},
{
title: 'Twitter',
title: 'Contribution',
items: [
{
html: `
<a href="https://twitter.com/zioscala">
<img src="https://img.shields.io/twitter/follow/zioscala?label=Follow&style=social" alt="twitter"/>
</a>
`
}
label: 'Contributor Guidelines',
href: '/contributor-guidelines'
},
{
label: 'Contributing to The ZIO Documentation',
href: '/contributing-to-the-documentation'
},
{
label: 'Coding Guidelines',
href: '/coding-guidelines'
},
],
},
{
title: 'Additional resources',
title: 'More',
items: [
{
label: 'Scaladoc of ZIO',
href: 'https://javadoc.io/doc/dev.zio/zio_2.12/'
label: 'Blog',
href: "/blog"
},
{
label: 'FAQ',
href: '/faq'
},
{
label: 'Adopters',
href: '/adopters'
},
{
label: 'Code of Conduct',
href: '/code-of-conduct'
}
],
},
Expand Down
12 changes: 1 addition & 11 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -581,15 +581,5 @@ module.exports = {
"resources/cheatsheets",
"resources/sampleprojects",
"resources/poweredbyzio"
],
"about-sidebar":
[
"about/index",
"about/faq",
"about/coding-guidelines",
"about/contributing",
"about/contributing-to-documentation",
"about/code-of-conduct",
"about/users",
]
]
}