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

Data type organization #4824

Merged
merged 65 commits into from Apr 1, 2021
Merged

Data type organization #4824

merged 65 commits into from Apr 1, 2021

Conversation

khajavi
Copy link
Member

@khajavi khajavi commented Mar 21, 2021

Most of the work on this pull request is about data type organization.
I think it's not ready to merge but would like to get feedback as soon as possible.
In this merge request, I changed the URL of some pages (data types and resources/ecosystem), so the old URLs become broken. I found this plugin to redirect the URLs, I need to migrate the whole documentation to Docusarous V2.0, which is not stable yet.

Some ongoing work on documentation:

  • Improve IO to reflect the main ZIO data type and introduce all type aliases
    • resource management
    • Unswallowed Exceptions
    • Unstoppable Finalizers
    • Improve documentation of Runtime data type
  • Write about three different types of workloads that a ZIO Fiber can handle in ZIO.
  • Add use case section for FiberRef
  • Organize Runtime, Platform, ZLayer, Has, and Chunk data types.
  • Resouce Management section on ZIO data type
  • document RefM data type

@khajavi
Copy link
Member Author

khajavi commented Mar 21, 2021

@jdegoes
Would love to get your feedback on what I did so far.

@khajavi khajavi force-pushed the data-type-organization branch 7 times, most recently from dcfc807 to 0ade392 Compare March 26, 2021 06:04
jdegoes
jdegoes previously approved these changes Mar 26, 2021
@jdegoes jdegoes closed this Mar 26, 2021
@jdegoes jdegoes reopened this Mar 26, 2021
@khajavi khajavi force-pushed the data-type-organization branch 5 times, most recently from e2703ca to 4a568b7 Compare March 29, 2021 17:10
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
note that the overview section with summary page is not the idiomatic
way of documentation with docusaurus.

Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
- Why fibers exist.
- Its difference with it's Java analog.
- Introduce some useful operation on fibers.
- Restructure the whole page.
- add section on their difference from ThreadLocal
- improve propagation semantic
- restructure the page's sections.
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
…type.

Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
Signed-off-by: Milad Khajavi <khajavi@gmail.com>
@jdegoes jdegoes merged commit a18f2a5 into zio:master Apr 1, 2021
@jdegoes
Copy link
Member

jdegoes commented Apr 1, 2021

@KadekM Given the amount of changes here, and given the fact the build passed, I went ahead and merged it. Please submit followup PRs for the remaining items.

Thank you for your work on this!

@assafj-wix
Copy link

Hi ppl, I've found some broken links in the Streaming section.

For example, on Streaming Summary the Stream link is broken.

Would you prefer a new Github issue with my findings? @jdegoes @KadekM

@KadekM
Copy link
Contributor

KadekM commented Apr 26, 2021

appreciate the mentions @jdegoes @assafj-wix but let me ping @khajavi who's behind all this work :-)

@khajavi khajavi mentioned this pull request Apr 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants