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

[Core Feature] Finish getting user documentation into Admin #2674

Open
wild-endeavor opened this issue Jul 6, 2022 · 3 comments
Open

[Core Feature] Finish getting user documentation into Admin #2674

wild-endeavor opened this issue Jul 6, 2022 · 3 comments
Assignees
Labels
Epic: User Doc Ex User documentation story (dochub) flyteidl flytekit FlyteKit Python related issue stale
Milestone

Comments

@wild-endeavor
Copy link
Contributor

wild-endeavor commented Jul 6, 2022

See #1235 for background information.

This issue is to finish up that work.

Motivation

Goal

Parse docstring in task/workflow, and register a description entity in flyteadmin.

@task 
def my_task(foo: int, bar: str) -> bool:
    """
    :param foo: Some foo description here
    :param bar: Other bar description here

    :return: Description of return type here
    ...

Description Entity Table

Name Type
resource string
project string
domain string
name string
version string
descriptionID uint32
Digest []byte
ShortDescription string
LongDescription []byte
link string

FlyteConsole: We should be able to see the description when listing tasks/workflows

image

@wild-endeavor wild-endeavor added this to the 1.2.0 milestone Jul 6, 2022
@wild-endeavor wild-endeavor self-assigned this Jul 6, 2022
@wild-endeavor wild-endeavor added flytekit FlyteKit Python related issue flyteidl Epic: User Doc Ex User documentation story (dochub) labels Jul 6, 2022
@wild-endeavor wild-endeavor changed the title Finish getting user documentation into Admin [Core Feature] Finish getting user documentation into Admin Jul 6, 2022
@eapolinario eapolinario modified the milestones: 1.2.0, 1.3.0 Oct 3, 2022
@cosmicBboy cosmicBboy modified the milestones: 1.3.0, 2023 Q1 Backlog Jan 25, 2023
@github-actions
Copy link

Hello 👋, This issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will close the issue if we detect no activity in the next 7 days. Thank you for your contribution and understanding! 🙏

@github-actions github-actions bot added the stale label Oct 23, 2023
@github-actions
Copy link

Hello 👋, This issue has been inactive for over 9 months and hasn't received any updates since it was marked as stale. We'll be closing this issue for now, but if you believe this issue is still relevant, please feel free to reopen it. Thank you for your contribution and understanding! 🙏

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 31, 2023
@eapolinario eapolinario reopened this Nov 2, 2023
@github-actions github-actions bot removed the stale label Nov 4, 2023
Copy link

github-actions bot commented Aug 1, 2024

Hello 👋, this issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will engage on it to decide if it is still applicable.
Thank you for your contribution and understanding! 🙏

@github-actions github-actions bot added the stale label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic: User Doc Ex User documentation story (dochub) flyteidl flytekit FlyteKit Python related issue stale
Projects
None yet
Development

No branches or pull requests

4 participants