Merge pull request #580 from newrelic/jerel/nr-only-edits

Move NR-only edits to manual-edits folder

Author: jerelmiller

scripts/utils/migrate/copy-manual-edits.js

@@ -1,6 +1,15 @@
 const fs = require('fs');
 const vfileGlob = require('vfile-glob');
 const { write } = require('to-vfile');
+const rimraf = require('rimraf');
+
+const deletedFiles = [
+  'src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/clear-cache.mdx',
+  'src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/html-cheat-sheet.mdx',
+  'src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/checklist-public-beta-or-ga.mdx',
+  'src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/hide-or-restrict-content.mdx',
+  'src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/translation-process.mdx',
+];
 
 const copyManualEdits = () => {
   return new Promise((resolve) => {
@@ -15,6 +24,7 @@ const copyManualEdits = () => {
         await write(file, 'utf-8');
       },
       complete: () => {
+        deletedFiles.forEach((file) => rimraf.sync(file));
         resolve();
       },
     });

src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/bold-or-code-not-italics.mdx

@@ -7,17 +7,18 @@ topics:
   - Basic style guide
   - Style guide quick reference
 redirects:
-  - >-
-    /docs/new-relic-only/basic-style-guide/writing-guidelines/bold-or-code-not-italics
+  - /docs/new-relic-only/basic-style-guide/writing-guidelines/bold-or-code-not-italics
 watermark: NR ONLY
 ---
 
-Do not format your text with italics. Instead, format your text using **bold** or `code` when necessary. For example:
+If you'd like to emphasize text in our docs, please follow these simple guidelines:
 
-* Use `code` for things the user is likely to copy and paste.
-* Use **bold** for anything else you need to emphasize.
+* Use `code` for things the user is likely to copy and paste, like a file path or a command line example.
+* Use **bold** for anything else you need to emphasize, like a UI name or to highlight an important word.
 
-The Tech Docs team follows these rules:
+We don't format text in our docs with **italics**.
+
+Here are more specific guidelines our team uses.
 
 <Table>
   <thead>
@@ -180,7 +181,7 @@ The Tech Docs team follows these rules:
       <td/>
 
       <td>
-        Go to **[rpm.newrelic.com/apm](https://rpm.newrelic.com/apm) > (select an app) > Overview > Web transactions**. For more information, see [UI paths](/docs/new-relic-only/basic-style-guide/writing-guidelines/usage-dictionary#ui-path).
+        Go to **[one.newrelic.com](https://one.newrelic.com) > APM > (select an app) > Transactions**. For more information, see [UI paths](/docs/new-relic-only/basic-style-guide/writing-guidelines/usage-dictionary#ui-path).
 
         <Callout variant="tip">
           If you have a UI object (page, tab, etc.) that also has link formatting, then you don't need to add the bold formatting.

src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/callouts.mdx

@@ -11,21 +11,23 @@ redirects:
 watermark: NR ONLY
 ---
 
-Callouts direct your attention to information of special importance or to information that doesn't fit smoothly into the main text. However, if there are too many callouts in your doc, it makes it confusing what exactly matters the most.
+Callouts direct your attention to information of special importance or to information that doesn't fit smoothly into the main text. Consider your reader. If your doc has too many callouts, it might confuse your reader about what matters the most and distract them from what does.
 
-Avoid littering your doc with an excessive number of callouts, because they can quickly distract readers. Instead, use them judiciously. **Recommendation:** Skim the complete doc. If there are too many callouts, decide which ones can be removed.
+Use your callouts judiciously. **Recommendation:** Skim the complete doc. If there are too many callouts, decide which ones can be removed.
 
 ## Types of callouts [#classes]
 
-Here is an example of the `callout` format:
+Here's an example of the `callout` format:
 
 ```
-<div class="callout-tip">
-  <p>Enclose your callouts in division tags.</p>
-</div>
+<Callout variant="tip">
+  Your tip text goes here.
+
+  It can have multiple paragraphs.
+</Callout>
 ```
 
-The Docs site uses these callout classes:
+On our Docs site, we use these callout classes:
 
 <CollapserGroup>
   <Collapser
@@ -54,7 +56,7 @@ The Docs site uses these callout classes:
     id="tr-tip"
     title={<>Tip (<InlineCode>callout-tip</InlineCode>)</>}
   >
-    **Tips** whisper to you that this is nice to know, like a shortcut, best practice, or reminder, but it is unnecessary to complete the task at hand. Tips use the `callout-tip` class. At a traffic light, a **Tip** would be a green light.
+    **Tips** whisper to you that this is nice to know, like a shortcut, best practice, or reminder, but is unnecessary to complete the task at hand. Tips use the `callout-tip` class. At a traffic light, a **Tip** would be a green light.
 
     <Callout variant="tip">
       If you have integrated your New Relic account with a [ticketing system](/docs/site/ticketing-integrations) such as Lighthouse, Pivotal Tracker, or Atlassian JIRA, you can use the note to file a ticket or story.
@@ -76,6 +78,8 @@ The Docs site uses these callout classes:
 
     Typically, pricing callouts appear in the intro of a doc. See the example below for standard verbiage in the callout.
 
+    With the new pricing model, these are rarely used.
+
     <Callout variant="tip">
       Access to this feature depends on your [subscription level](http://newrelic.com/application-monitoring/pricing).
     </Callout>

src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/capitalization.mdx

@@ -11,19 +11,19 @@ redirects:
 watermark: NR ONLY
 ---
 
-This explains how to decide what to capitalize in a document's title, headings, products, features, and other elements of the page.
+In general, we only capitalize things when we need to. Read on for some guidelines on how to decide what to capitalize in a document's title, headings, products, features, and other elements of the page.
 
 ## Use sentence case in headings [#heading_caps]
 
-Use sentence case for headings, including category headings and document titles. With sentence case, capitalize only the first letter of:
+Use sentence case for headings. This includes category headings and document titles. With sentence case, capitalize only the first letter of:
 
 * The first word
 * Proper nouns
 * Acronyms and abbreviations
 
-**Exceptions:**
+**We have some exceptions:**
 
-* If the heading is a code term, such as a variable or function, then capitalize it exactly as it is used in the code; for example: [`noticeError`](/docs/browser/new-relic-browser/browser-agent-spa-api/notice-error).
+* If the heading is a code term, such as a variable or function, then capitalize it exactly as it's used in the code; for example: [`noticeError`](/docs/browser/new-relic-browser/browser-agent-spa-api/notice-error).
 * If the heading includes a colon, follow the [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/punctuation/colons#in-titles-and-headings) for titles and headings, and capitalize the first word that appears after the colon; for example: [APM Error profiles: Troubleshoot trends](/docs/apm/applications-menu/error-analytics/apm-error-profiles-troubleshoot-trends).
 
 ## Products and features [#features]
@@ -44,7 +44,7 @@ Use sentence case for headings, including category headings and document titles.
   <tbody>
     <tr>
       <td>
-        Use title case for products.
+        We use title case for products.
       </td>
 
       <td>
@@ -54,7 +54,7 @@ Use sentence case for headings, including category headings and document titles.
 
     <tr>
       <td>
-        Do not capitalize features.
+        We don't capitalize features.
       </td>
 
       <td>
@@ -82,7 +82,7 @@ Use sentence case for headings, including category headings and document titles.
   <tbody>
     <tr>
       <td>
-        Use sentence case and bold for UI elements, even if the UI element is in a different case in the UI.
+        We use sentence case and bold for UI elements, even if the UI element is in a different case in the UI.
       </td>
 
       <td>
@@ -92,11 +92,11 @@ Use sentence case for headings, including category headings and document titles.
 
     <tr>
       <td>
-        Use sentence case and bold for each element in a path that references UI pages.
+        We use sentence case and bold for each element in a path that references UI pages.
       </td>
 
       <td>
-        Go to **[rpm.newrelic.com/apm](https://rpm.newrelic.com/apm) >** **Transactions > Transaction traces > (select a trace) > Another thing**.
+        Go to **[one.newrelic.com](https://one.newrelic.com) >** **APM > Transactions > Transaction traces > (select a trace) > Another thing**.
       </td>
     </tr>
   </tbody>
@@ -120,7 +120,7 @@ Use sentence case for headings, including category headings and document titles.
   <tbody>
     <tr>
       <td>
-        Use all caps for BETA or NR ONLY.
+        We use all caps for BETA or NR ONLY.
       </td>
 
       <td>

src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/clamshells.mdx

@@ -11,7 +11,7 @@ redirects:
 watermark: NR ONLY
 ---
 
-Clamshells are expandable elements that hide page content until you [trigger it open](#trigger-clamshell). Use clamshells to hide content in very long documents. Here is an example clamshell:
+Clamshells are expandable elements that hide page content until you [trigger it open](#trigger-clamshell). We use clamshells to hide content in very long documents, out of consideration for our readers. Here's an example clamshell:
 
 <CollapserGroup>
   <Collapser
@@ -64,7 +64,7 @@ Here are some examples of when to use clamshells in your document.
       </td>
 
       <td>
-        Here is an example when you have multiple options, such as a procedure with steps that vary depending on your application environment: [Collecting PMI metrics](/docs/agents/java-agent/frameworks/websphere-installation-java#collecting-pmi).
+        Here's an example when you have multiple options, such as a procedure with steps that vary depending on your application environment: [Collecting PMI metrics](/docs/agents/java-agent/frameworks/websphere-installation-java#collecting-pmi).
       </td>
     </tr>
 
@@ -74,7 +74,7 @@ Here are some examples of when to use clamshells in your document.
       </td>
 
       <td>
-        Here is an example when you have a code block that is longer than about one screen height: [Writing API tests](/docs/synthetics/new-relic-synthetics/scripting-monitors/writing-api-tests#get).
+        Here's an example when you have a code block that is longer than about one screen height: [Writing API tests](/docs/synthetics/new-relic-synthetics/scripting-monitors/writing-api-tests#get).
       </td>
     </tr>
 
@@ -84,24 +84,24 @@ Here are some examples of when to use clamshells in your document.
       </td>
 
       <td>
-        Here is an example when you want a cleaner substitute for `h3` tags when subdividing an `h2` header: [Installing the PHP agent manually](/docs/agents/php-agent/installation/php-agent-installation-non-standard-php#manual). Unlike an `h3`, clamshells allow users to see all the options within a section at a glance without having to scroll.
+        Here's an example when you want a cleaner substitute for `h3` tags when subdividing an `h2` header: [Installing the PHP agent manually](/docs/agents/php-agent/installation/php-agent-installation-non-standard-php#manual). Unlike an `h3`, clamshells allow users to see all the options within a section at a glance without having to scroll.
       </td>
     </tr>
   </tbody>
 </Table>
 
 ## Create a clamshell [#create]
 
-To create a clamshell, you must use the **Source** editor. To edit existing clamshells, you can use **Source** or WYSIWYG. Clamshells are identified by a **-- fold --** label in the WYSIWYG editor.
+To create a clamshell, you'll need to use our clamshell code.
 
-Here is an example of clamshell source:
+Here's an example of the clamshell source:
 
+```
 <CollapserGroup>
   <Collapser
     id="clamshell-source"
     title="Clamshell source"
   >
-    ```
     <dl class="clamshell-list">
 
     <dt id="clamshell-1">Clamshell 1</dt>
@@ -113,16 +113,15 @@ Here is an example of clamshell source:
     <dd>
         <p>This is the second example clamshell.</p>
     </dd>
-
-    </dl>
-    ```
+    </dl>  
   </Collapser>
 </CollapserGroup>
+```
 
 ## Clamshells triggers [#trigger-clamshell]
 
-Clamshells will open or close by:
+To open or close a clamshell:
 
-* Selecting the open buttons or **Show/Hide All**.
-* Arriving at an individual clamshell via the URL. For example, go directly to [Clamshell 1 in the example above](/docs/new-relic-only/basic-style-guide/writing-guidelines/clamshells#clamshell-1).
-* Typing the shortcut keys `s` (to **s**how) and `h` (to **h**ide).
+* Click the open buttons or **Show/Hide All**.
+* Arrive at an individual clamshell via its URL. For example, go directly to [Clamshell 1 in the example above](/docs/new-relic-only/basic-style-guide/writing-guidelines/clamshells#clamshell-1).
+* Type the shortcut keys `s` (to **s**how) and `h` (to **h**ide).

src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/code-examples.mdx

@@ -11,7 +11,7 @@ redirects:
 watermark: NR ONLY
 ---
 
-Use the `<code>`, `<pre>`, and `<var>` tags to indicate "raw" technical content such as excerpts from a config file, an API method name, or a file path.
+We use a variety of formatting to highlight code or other technical language. You can use the `<code>`, `<pre>`, and `<var>` tags to indicate "raw" technical content such as excerpts from a config file, an API method name, or a file path.
 
 <CollapserGroup>
   <Collapser
@@ -20,7 +20,6 @@ Use the `<code>`, `<pre>`, and `<var>` tags to indicate "raw" technical content
   >
     To surround small blocks of code or data (single words or lines), mark as code:
 
-    * **WYSWIYG**: Highlight the text, then select **Styles > Code** from the WYSIWYG formatting bar.
     * **Source**: Use `<code>` tags.
     * **Markdown**: Surround the text with backtick `` ` `` characters.
   </Collapser>
@@ -31,7 +30,6 @@ Use the `<code>`, `<pre>`, and `<var>` tags to indicate "raw" technical content
   >
     To surround longer blocks of data that run multiple lines, mark as preformatted text:
 
-    * **WYSIWYG**: Highlight the text, then select **Styles > Pre tag** from the WYSIWYG formatting bar.
     * **Source**: Use `<pre>` tags.
     * **Markdown**: Do not use Markdown-style indented code formatting, as this can cause unexpected formatting problems.
   </Collapser>

src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/docs-styles-quick-reference.mdx

@@ -12,11 +12,10 @@ redirects:
 watermark: NR ONLY
 ---
 
-This document lists the "house" HTML classes used on [docs.newrelic.com](https://docs.newrelic.com).
+This document lists the "house" Markdown used on [docs.newrelic.com](https://docs.newrelic.com).
 
 * Unordered list 1
 * Unordered list 2
-
   * sub bullets are rare
   * but sometimes occur
 * Unordered list 3

src/content/docs/new-relic-only/basic-style-guide/style-guide-quick-reference/example-box-clamshell.mdx

@@ -9,12 +9,11 @@ topics:
 redirects:
   - /docs/new-relic-only/basic-style-guide/writing-guidelines/example-shell
   - /docs/new-relic-only/basic-style-guide/writing-guidelines/example-clamshell
-  - >-
-    /docs/new-relic-only/basic-style-guide/writing-guidelines/example-box-clamshell
+  - /docs/new-relic-only/basic-style-guide/writing-guidelines/example-box-clamshell
 watermark: NR ONLY
 ---
 
-Use the `examplebox` class with <div> tags to enclose short examples, or use example clamshells with the `example-box` class to enclose more extended examples or procedures. Examples are useful to indicate where the "meat" of a section ends and the illustration begins. This is particularly true when the example is so long it makes the parent section appear intimidating, but is not so important that it deserves its own section.
+You can use code example boxes to provide lengthy code examples in a way that's visually distinct and doesn't take up too much space. You can also include these example boxes as part of a clamshell.
 
 For example, see this [Java agent API call](/docs/agents/java-agent/custom-instrumentation/java-agent-api-example-program#complete-api-example).