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

Lift keyword-containing text from Starlark docs to ytt docs to increase hit rate / decrease time to answer #702

Open
pivotaljohn opened this issue Jul 5, 2022 · 0 comments
Labels
documentation This issue indicates a change to the docs should be considered priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence but not planned. Contributions are welcome.

Comments

@pivotaljohn
Copy link
Contributor

Describe the problem/challenge you have
Documentation about core Starlark language functionality is pointed too (and not copied) and doesn't show up in search results.

Exhibit A:

Sorry for the repeat offenses, team. I'm having some trouble getting string concatenation working and a search on the docs yields nothing.

image

Describe the solution you'd like
Select portions of Starlark docs that include likely keywords and copy into ytt docs (retaining link to the source).

Anything else you would like to add:
The example given is just an example. Consider:

  • what other actions one would take on Starlark-native values
  • what types does that action apply.

To extend this example: not only can strings be concatenated, but so can lists, tuples, and dictionaries.

Thanks goes to @drawsmcgraw for noting this deficiency. 🙏🏻


Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

@pivotaljohn pivotaljohn added enhancement This issue is a feature request carvel triage This issue has not yet been triaged for relevance documentation This issue indicates a change to the docs should be considered priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence but not planned. Contributions are welcome. and removed enhancement This issue is a feature request carvel triage This issue has not yet been triaged for relevance labels Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue indicates a change to the docs should be considered priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence but not planned. Contributions are welcome.
Projects
Status: To Triage
Development

No branches or pull requests

1 participant