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

Improve docs around inputs and arguments #4556

Closed
alexec opened this issue Nov 18, 2020 · 3 comments
Closed

Improve docs around inputs and arguments #4556

alexec opened this issue Nov 18, 2020 · 3 comments
Assignees
Labels
good first issue Good for newcomers type/feature Feature request

Comments

@alexec
Copy link
Contributor

alexec commented Nov 18, 2020

New Relic highlighted that it is hard to understand these concepts.

@alexec alexec added the type/feature Feature request label Nov 18, 2020
@alexec alexec added the good first issue Good for newcomers label Nov 30, 2020
@kennytrytek
Copy link
Contributor

Hi Alex. I'd be interested in taking this one on, as I also found it initially very difficult to reason about the nuances of inputs. Do you have any more context about any specific concepts New Relic found hard to grasp, or should I just do an overview of the existing documentation and see where there are opportunities to update or add clarifying documentation?

The Beginner section of the user guide seems like a section that could have a page specific to the different types of inputs and outputs maybe highlighting parts of some existing examples?

@alexec
Copy link
Contributor Author

alexec commented Jan 10, 2021

That'd be great - do you want to submit a PR with some new docs?

@kennytrytek
Copy link
Contributor

Docs PR merged; this can be closed unless there was more work to do?

@alexec alexec closed this as completed Mar 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers type/feature Feature request
Projects
None yet
Development

No branches or pull requests

2 participants