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

Documentation usability feedback for run.md #170

Closed
frankfarzan opened this issue Jan 22, 2020 · 1 comment
Closed

Documentation usability feedback for run.md #170

frankfarzan opened this issue Jan 22, 2020 · 1 comment
Assignees
Labels
area/hydrate triaged Issue has been triaged by adding an `area/` label

Comments

@frankfarzan
Copy link
Contributor

frankfarzan commented Jan 22, 2020

https://github.com/GoogleContainerTools/kpt/blob/master/docs/fn/run.md

  • Caveats section is very long since it's explaining multiple concepts. It's probably worth creating subsection for each
  • Need to use verbatim code style in many instances. e.g. metadata.annotations.[config.kubernetes.io/function]. Otherwise, it's hard to read.
  • Config Functions -> KPT Functions ?
  • We should simplify number of ways to invoke functions declarativey. Or at least, emphasize one approach in docs so user doesn't get overwhelmed.
  • It's ambiguous whether functions directory is required or just a convention used (functions dir is in fact a special dir recognized by kpt).
  • Also note that the implicit pattern is currently broken: kpt fn run scoping broken #188
@pwittrock pwittrock added this to the 0.2.0 milestone Feb 20, 2020
@selfmanagingresource selfmanagingresource removed this from the 0.5 milestone Mar 17, 2020
@pwittrock pwittrock added this to the 2020-Q3: Functions and Environments milestone Mar 18, 2020
@frankfarzan frankfarzan added the triaged Issue has been triaged by adding an `area/` label label May 27, 2020
@frankfarzan frankfarzan self-assigned this Jun 4, 2020
@frankfarzan frankfarzan modified the milestones: Milestone 3 (Starts 2020-Q3), Milestone 2 (Starts 2020-Q2) Jun 4, 2020
@sankit2020 sankit2020 removed this from the Milestone 2 (Starts 2020-Q2) milestone Jun 24, 2020
@droot
Copy link
Contributor

droot commented Dec 9, 2020

This will be addressed with the docs revamp (and pipeline implementation) targeted for v1.0

@droot droot closed this as completed Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/hydrate triaged Issue has been triaged by adding an `area/` label
Projects
None yet
Development

No branches or pull requests

5 participants