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] Capture and save documentation from flytekit entities #1369

Open
katrogan opened this issue Aug 24, 2021 · 3 comments
Open

[Core Feature] Capture and save documentation from flytekit entities #1369

katrogan opened this issue Aug 24, 2021 · 3 comments
Assignees
Labels
enhancement New feature or request stale

Comments

@katrogan
Copy link
Contributor

katrogan commented Aug 24, 2021

Motivation: Why do you think this is important?
See #531 for a richer discussion on this feature. For this specific issue, we will want to capture user documentation, links to source code and commit version and pipe that through the Flyte system and make entity descriptions for tasks, workflows, launch plans and executions retrievable via a separate endpoint.

Goal: What should the final outcome look like, ideally?
It should be possible to add RST-formatted documentation inline with flytekit entity definitions or when launching executions from any means and have that information made retrievable by end users.

Describe alternatives you've considered
Again, see #531

[Optional] Propose: Link/Inline OR Additional context
Design doc: https://docs.google.com/document/d/1wvCvM6pLQ17Zr0DcpS9es2vOFQsNeOaNN99ufGw8O1U/edit?usp=sharing

@katrogan katrogan added the enhancement New feature or request label Aug 24, 2021
@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 Aug 27, 2023
@github-actions
Copy link

github-actions bot commented Sep 3, 2023

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 Sep 3, 2023
@eapolinario eapolinario reopened this Nov 2, 2023
@github-actions github-actions bot removed the stale label Nov 3, 2023
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 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 Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request stale
Projects
None yet
Development

No branches or pull requests

3 participants