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

UI should display documentations for the steps of a pipeline #227

Closed
vicaire opened this issue Nov 13, 2018 · 5 comments
Closed

UI should display documentations for the steps of a pipeline #227

vicaire opened this issue Nov 13, 2018 · 5 comments

Comments

@vicaire
Copy link
Contributor

vicaire commented Nov 13, 2018

It would be very useful to have the documentation of a pipeline and its steps readily available in the UI.

Ideally:

  • The user should be able to specify documentation using our Python library.
  • The documentation would be part of the pipeline package.
  • The UI would display the documentation

Example documentation needed:

  • What does the step do?
  • What are the parameters?
  • How to make calls to the deployed server? (Cloud ML engine serving, in-cluster TF serving)
  • Etc.
@yebrahim
Copy link
Contributor

Agree. The static pipeline graph view seems like a good place to explain what the pipeline does.
@ajayalfred we will want to account for this in the static graph details.

@ajayalfred
Copy link
Contributor

Good point. I'll make a note of design mocks needed.

@Ark-kun
Copy link
Contributor

Ark-kun commented Nov 13, 2018

My components design has human names, description and optionally a documentation link and source link. I'm planning to add this information to the container template metadata section as annotations. Then we can use this information in the UI. https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

@vicaire
Copy link
Contributor Author

vicaire commented Nov 15, 2018

@Ark-kun, please get a review before proceeding with this implementation.

@vicaire
Copy link
Contributor Author

vicaire commented Mar 27, 2019

Closing in favor of #525

@vicaire vicaire closed this as completed Mar 27, 2019
magdalenakuhn17 pushed a commit to magdalenakuhn17/pipelines that referenced this issue Oct 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants