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

docs: ensure consistency #458

Merged
merged 3 commits into from
Mar 17, 2020
Merged

docs: ensure consistency #458

merged 3 commits into from
Mar 17, 2020

Conversation

ctrombley
Copy link
Contributor

This PR improves the documentation for the project in a few ways:

  • Add import sections to website docs where they were missing
  • Add description attributes to most schema fields
  • Add missing information to certain website docs
  • Ensure consistency across docs pages

@ctrombley ctrombley requested a review from jthurman42 March 11, 2020 18:04
@ghost ghost added size/XL documentation Improvements or additions to documentation labels Mar 11, 2020
@ctrombley ctrombley changed the title Docs/ensure consistency docs: ensure consistency Mar 11, 2020
jthurman42
jthurman42 suggested changes Mar 11, 2020
View reviewed changes
Copy link
Contributor

@jthurman42 jthurman42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, this is awesome, a ton of improvements. A few minor changes to be consistent throughout on showing the possible values when options are limited to a set.

newrelic/data_source_newrelic_alert_channel.go Outdated Show resolved Hide resolved
newrelic/resource_newrelic_alert_channel.go Show resolved Hide resolved
newrelic/resource_newrelic_infra_alert_condition.go Outdated Show resolved Hide resolved
newrelic/resource_newrelic_synthetics_monitor.go Outdated Show resolved Hide resolved
jthurman42
jthurman42 approved these changes Mar 11, 2020
View reviewed changes
Copy link
Contributor

@jthurman42 jthurman42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

zlesnr
zlesnr approved these changes Mar 12, 2020
View reviewed changes
Copy link
Contributor

@zlesnr zlesnr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent.

@ctrombley ctrombley merged commit 1339ca9 into master Mar 17, 2020
@ctrombley ctrombley deleted the docs/ensure-consistency branch March 17, 2020 16:37
kidk pushed a commit to aminoz007/terraform-provider-newrelic that referenced this pull request Oct 12, 2021
@ctrombley
docs: ensure consistency (newrelic#458)
16dfe79 
* docs: updates for consistency and thoroughness

* docs: add import sections where they were missing

* chore: incorporate code review feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zlesnr zlesnr zlesnr approved these changes

@jthurman42 jthurman42 jthurman42 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ctrombley @jthurman42 @zlesnr