Skip to content

Commit

Permalink
Merge pull request #115 from newrelic/links-component-guide
Browse files Browse the repository at this point in the history
added links to new component guide
  • Loading branch information
caylahamann authored Jun 10, 2020
2 parents 90c826e + 8f2056d commit 49a7497
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* [Submitting a PR from a cloned repo](#submitting-a-pr-from-a-cloned-repo)
- [Deploy previews with Amplify](#deploy-previews-with-amplify)
- [Style guide adherence](#style-guide-adherence)
- [Reusable components](#reusable-components)
- [Technical reference contribution guidelines](#technical-reference-contribution-guidelines)
* [Editing existing pages](#editing-existing-pages)
* [Creating new pages](#creating-new-pages)
Expand Down Expand Up @@ -84,6 +85,11 @@ In order to drive consistency in our documentation New Relic has provided a deta
for you to follow when making contributions. Refer to this guide prior to contributing.
When making documentation contributions follow these guidelines.

# Reusable components

In order to drive simplicity and ease of use New Relic has provided a set of reusable components you can leverage
when creating documentation. Refer to our [Component Guide](COMPONENT_GUIDE.md) for more information.

# Technical reference contribution guidelines

Technical reference pages are detailed technical specifications of the New Relic One platform and it's components.
Expand Down
16 changes: 11 additions & 5 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
* [Guides](#guides)
* [Overview pages](#overview-pages)
- [The writing process](#the-writing-process)
* [Consider the New Relic "voice"](#consider-the-new-relic-voice)
* [Writing style](#writing-style)
* [Think of your audience](#think-of-your-audience)
+ [Audience for guides](#audience-for-guides)
+ [Audience for technical references](#audience-for-technical-references)
Expand All @@ -23,18 +21,21 @@
* [Avoid emojis, slang, and metaphors](#avoid-emojis-slang-and-metaphors)
* [Define jargon](#define-jargon)
- [Writing Style](#writing-style)
* [Be explicit and opinionated](#be-explicit-and-opinionated)
* [Make it easy to scan](#make-it-easy-to-scan)
* [Write concisely](#write-concisely)
* [Use clear hyperlinks](#use-clear-hyperlinks)
* [Don't over link content references](#dont-over-link-content-references)
* [Use relative hyperlinks for local links](#use-relative-hyperlinks-for-local-links)
* [Mark localhost URLs as code strings](#mark-localhost-urls-as-code-strings)
* [Indicate when something is optional](#indicate-when-something-is-optional)
* [Abbreviate terms](#abbreviate-terms)
* [Use SEO optimized titles and descriptions](#use-seo-optimized-titles-and-descriptions)
* [Using Gatsby templates](#using-gatsby-templates)
+ [Types of templates](#types-of-templates)
* [Using Frontmatter](#using-frontmatter)
+ [Frontmatter slugs](#frontmatter-slugs)
+ [Frontmatter example](#frontmatter-example)
+ [GuideTemplate Frontmatter slugs](#guidetemplate-frontmatter-slugs)
+ [GuideTemplate Frontmatter example](#guidetemplate-frontmatter-example)
+ [Reusable components](#reusable-components)
- [Grammar and formatting](#grammar-and-formatting)
* [Format titles](#format-titles)
* [Format headers](#format-headers)
Expand Down Expand Up @@ -278,6 +279,11 @@ description: 'Example guide page'
---
```

### Reusable components

In order to drive simplicity and ease of use New Relic has provided a set of reusable components you can leverage
when creating documentation. Refer to our [Component Guide](COMPONENT_GUIDE.md) for more information.

# Grammar and formatting

## Format titles
Expand Down

0 comments on commit 49a7497

Please sign in to comment.