diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd894aa78..d46fc0919 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -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. diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 192d3494a..e2ae30558 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -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) @@ -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) @@ -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