Annotate resource with free text field
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 10.1k
- Forks
- 413
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 6
Description
Description
As requested by a user in a private chat: https://windmill-eng.slack.com/archives/CP17K27B7/p1583362268002400
Allow a "free text field" to be associated with every resource. You specify the text in the Tiltfile itself. So that when you run Tilt, you can see the value in the web UI. The field should probably understand some basic markdown and/or HTML.
Why
This would allow users to annotate resources and make them more human-readable / understandable. This is similar to a label description field in GitHub or the channel topic in Slack. It could simply be a brief description. It could be a link to the README of the service/resource. Or it could even be a URL to a particular environment.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how resources are declared in the Tiltfile and represented in the web UI; the issue names no files or tests. Confirm where resource metadata flows and clarify the supported text, Markdown, or HTML behavior. Done means a resource can carry the annotation from the Tiltfile and display it in the web UI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- full-stack
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100