Skip to content

Commit

Permalink
Merge pull request #2510 from newrelic/austin-schaefer-patch-4
Browse files Browse the repository at this point in the history
Tweak readme to reduce word count and make it less "new"
  • Loading branch information
austin-schaefer committed May 27, 2021
2 parents f1dcb55 + 79c34f2 commit eaaffa6
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Expand Up @@ -2,15 +2,15 @@

# docs.newrelic.com

Welcome! 👋 This is the repo for the `NEW` New Relic Docs site. This repo contains all the Docs website source code and Markdown source files we use to build our Docs site: `docs.newrelic.com`.
Welcome! 👋 This is the repo for [docs.newrelic.com](https://docs.newrelic.com). This repo contains all the source code and Markdown source files we use to build our docs site.

Read on to learn more about who we are and how you can contribute to the New Relic Docs site.

## We'd like your help

From early on, our Docs site has been managed by a team of writers. We've always welcomed contributions from anyone at New Relic and now we're open sourcing our docs to invite input from anyone at all. We credit our technical accuracy and comprehensive documentation to this openness.
From the start, we've welcomed contributions from anyone at New Relic, not just writers. Now, we're open sourcing our docs to invite input from anyone at all. We credit our technical accuracy and comprehensive documentation to this openness.

In a sense, it's documentation as conversation. By making our docs open source, we hope to expand this conversation. Open sourcing our docs seemed like a great way to expand this conversation beyond New Relic.
In a sense, it's documentation as conversation. By making our docs open source, we hope to expand this conversation.

We're here working every day to improve our docs and we'd love to hear from you. Come join the conversation.

Expand All @@ -20,9 +20,7 @@ On each page of our docs, you can [create an issue](https://github.com/newrelic/

### Create an issue

Issues are a quick way to give us feedback about our docs. We'll review your issue and follow up with you if we have any questions.
You can create an issue to let us know when you find an error or notice something missing. You can also let us know about things you'd like to see.
Go here to [create an issue](https://github.com/newrelic/docs-website/issues/new/choose).
Issues are a quick way to give us feedback about our docs. We'll review your issue and follow up with you if we have any questions. You can create an issue to let us know when you find an error or notice something missing. You can also let us know about things you'd like to see. Go here to [create an issue](https://github.com/newrelic/docs-website/issues/new/choose).

### Edit a page

Expand All @@ -34,12 +32,10 @@ If you'd like to get more directly involved, you can edit the docs yourself! Her

If you'd like more information on how to edit our docs, see our [content contribution guide](/docs/style-guide/writing-guidelines/create-edit-content/). Additionally, our [Style guide](https://docs.newrelic.com/docs/style-guide) will give you some insight into how we think about writing and documentation, as well as our flavor of Markdown.

If you'd like to go deeper, see our [Contributors guide](CONTRIBUTING.md) for information on how to fork our site, build it locally, and submit pull requests.



Reading the style guide is totally optional! Our writers are here to make sure everything is formatted and worded right. We're looking your technical insight and knowhow. Let us handle the little details for you.

If you'd like to go deeper with development, see our [Contributors guide](CONTRIBUTING.md) for information on how to fork our site, build it locally, and submit pull requests.

## 🚧 Contributing

We welcome contributions to the New Relic Docs Site. Please review our [Contributors Guide](CONTRIBUTING.md) prior to submitting any code.
Expand Down

0 comments on commit eaaffa6

Please sign in to comment.