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.

Sign up for GitHub

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

Jump to bottom

Improve config docs with "Added in" info #1134

Open
watson opened this issue Jun 17, 2019 · 3 comments · May be fixed by #1788
Open

Improve config docs with "Added in" info #1134

watson opened this issue Jun 17, 2019 · 3 comments · May be fixed by #1788
Labels
agent-nodejs Make available for APM Agents project planning. docs good first issue

Comments

@watson
Copy link
Contributor

watson commented Jun 17, 2019 •
edited
Loading

Similar to our API docs improvements in #975 and #1000, we should add an Added in label to the config docs as well.
@watson watson added the docs label Jun 17, 2019
@watson
Copy link
Contributor Author

watson commented Jun 19, 2019

@bmorelli25 what do you think about this one? Should we just follow the style of the API docs?

@bmorelli25
Copy link
Member

Should we just follow the style of the API docs?

I think so. The format used there should work well in config docs too, e.g: [small]#Added in: v2.0.0#

@bmorelli25 bmorelli25 mentioned this issue Oct 2, 2019
Closed
8 tasks
@bmorelli25
Copy link
Member

Added good first issue as this issue just requires someone to dig through the changelog for configuration additions and to note them in configuraiton.asciidoc in the following format: [small]#Added in: v1.5.0#. See the API documentation for an example of what this looks like.

adityahiran added a commit to adityahiran/apm-agent-nodejs that referenced this issue Jul 4, 2020
@adityahiran
docs: add version in which the configurations were added elastic#1134
161e542
@adityahiran adityahiran linked a pull request Jul 4, 2020 that will close this issue
Open
@trentm trentm added the agent-nodejs Make available for APM Agents project planning. label Nov 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
agent-nodejs Make available for APM Agents project planning. docs good first issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add version in which the configurations were added #1134 adityahiran/apm-agent-nodejs
3 participants
@watson @trentm @bmorelli25