Skip to content

docs: add user guide#1292

Merged
samsja merged 12 commits intofeat-rewrite-v2from
docs-add-user-guide
Apr 3, 2023
Merged

docs: add user guide#1292
samsja merged 12 commits intofeat-rewrite-v2from
docs-add-user-guide

Conversation

@samsja
Copy link
Copy Markdown
Member

@samsja samsja commented Mar 27, 2023

Context

Early PR to merge the beginning of the documentation

  • Add user guide section with a first add install instruction
  • add pre-commit hooks for blacken docs
  • rename tutorials to how to
  • change docs structure

https://ft-docs-add-user-guide--jina-docs.netlify.app](https://ft-docs-add-user-guide--jina-docs.netlify.app/

@github-actions
Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

Signed-off-by: samsja <[email protected]>
@samsja samsja changed the title Docs add user guide docs: add user guide Mar 30, 2023
Copy link
Copy Markdown
Member

@JohannesMessner JohannesMessner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! We will have to do loads of polishing work, move stuff around, add or remove sections, but let's not get bogged down too much, I think this is a great starting point!


class ImageDoc(BaseDoc):
url: VideoUrl
bytes: VideoBytes = (
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No if you put =None it is optional by default

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think it is more explicit to have optional ?

@samsja samsja force-pushed the docs-add-user-guide branch from 5b6f784 to 3d5b660 Compare March 30, 2023 10:04
@samsja samsja marked this pull request as ready for review March 30, 2023 10:48
samsja and others added 2 commits March 31, 2023 11:25
Signed-off-by: samsja <[email protected]>
Co-authored-by: Johannes Messner <[email protected]>
Signed-off-by: samsja <[email protected]>
samsja and others added 2 commits March 31, 2023 12:27
Signed-off-by: samsja <[email protected]>
Signed-off-by: Alex C-G <[email protected]>
Copy link
Copy Markdown
Contributor

@jupyterjazz jupyterjazz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left some comments

* Will perform data validation: `BaseDoc` will check that the data you pass to it is valid. If not, it will raise an
error. Data being "valid" is actually defined by the type used in the type hint itself, but we will come back to this concept later. (TODO add typing section)
* Can be configured using a nested `Config` class, see Pydantic [documentation](https://docs.pydantic.dev/usage/model_config/) for more detail on what kind of config pydantic offers.
* Can be used as a drop-in replacement for `BaseModel` in your code and is compatible with tools that use Pydantic like [FastAPI]('https://fastapi.tiangolo.com/').
Copy link
Copy Markdown
Contributor

@jupyterjazz jupyterjazz Apr 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note to reference FastAPI integration page here that I'm currently working on for whoever merges the second

Co-authored-by: Saba Sturua <[email protected]>
Signed-off-by: samsja <[email protected]>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2023

📝 Docs are deployed on https://ft-docs-add-user-guide--jina-docs.netlify.app 🎉

@samsja samsja dismissed JohannesMessner’s stale review April 3, 2023 07:46

seems like he don't want to review :(

@samsja samsja merged commit c0718e5 into feat-rewrite-v2 Apr 3, 2023
@samsja samsja deleted the docs-add-user-guide branch April 3, 2023 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants