Move data type Docs to KDocs

[i-walker]

This Issue addresses the incremental move towards KDocs as a Single Source of Truth regarding data types in Λrrow.

Which Doc's need to be moved to Kdocs?

Under modules/docs/arrow-docs/docs/_data/sidebar.yml you can view a list of data types and their permalink:

  - title: Data Types

    nested_options:
    # ....
      - title: Option
        url: /docs/arrow/core/option/

      - title: Either
        url: /docs/arrow/core/either/

      - title: Try
        url: /docs/arrow/core/try/

Data types, which do not have a permalink starting with: url: /docs/apidocs/... are in the scope of this task, e.g.: Option, Either, Try, etc.

What needs to be done?

Essentially, we're trying to mirror this PR #1474 for the Id data type.

- LookUp the docs in `modules/docs/arrow-docs/docs/docs/arrow/data`
- [ ] Replace `kotlin:ank` -> `kotlin:ank:playground`
- [ ] Add specific imports avoid wildcard imports, but take this with a grain of salt
- [ ] Place the snippet over the data type declaration
- Test if everything runs: ./gradlew clean :arrow-docs:runAnk 
- Build the site locally (very long task): 
   ./gradlew clean dokka :arrow-docs:runAnk ;
   cd modules/docs/arrow-docs/build/site; 
   jekyll serve;
- [ ] Replace the relativ permalink in sidebar.yaml with :  /docs/apidocs/<Path to data type>
- [ ] `Replace in Path` the old link with the new one

A local build is required, because the remote build does not have your binaries. Hence, a remote lookup at the webpage won't be sufficient.
The list:

• Option
• Either
• Try
• Validated
• NonEmptyList
• ListK
• SequenceK
• SetK
• MapK
• SortedMapK
• Ior
• Id
• Reader
• Kleisli
• State
• StateT
• Store
• Moore
• Eval
• Sum
• Day
• WriterT
• Trampoline
• OptionT
• EitherT
• Function0
• Function1
• Const

[maruiz81]

Hi! I can take this task

[i-walker]

Ok :)
Ping me on the Arrow slack channel or link me in the PR and I'll be glad to assist.

[maruiz81]

Thanks, I will do

[maruiz81]

Hi, I have a question: Some of the Datatypes contains a youtube video. These don't work when I move to the comment. Is there any way to make them work? I couldn't find any example.

[i-walker]

share your PR, then I can help you :)

[maruiz81]

I have created the PR #1493 to show you. My problem is in the class option. Originally the README.md contained this:
`---
layout: docs
title: Option
permalink: /docs/arrow/core/option/
redirect_from:

• /docs/datatypes/option/

video: 5SFTbphderE
---`
which among other things I think show the youtube video for the Option functionality. So my question is how can I add a way which works with Ank.

Thanks

[raulraja]

closing this issue as all data types docs were already moved, and now kdoc is the preferred way. thanks!