Skip to content

Commit 6930d94

Browse files
authored
Merge pull request #559 from newrelic/Updates-to-processes-procedures-docs-DOC-6424
DOC-6424 - style guide edits
2 parents 7b9c5b6 + 8613bcf commit 6930d94

File tree

4 files changed

+12
-107
lines changed

4 files changed

+12
-107
lines changed

src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/clear-cache.mdx

Lines changed: 0 additions & 23 deletions
This file was deleted.

src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/delete-document.mdx

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,9 @@ redirects:
1515
When you delete a document, its content and all redirects to it are completely and irreversibly deleted. If you believe the document may be of use in the future, OR if you do not want to re-create its redirects, consider another method to [hide the document](/docs/new-relic-only/advanced-style-guide/processes-procedures/hiding-content) from public view.
1616
</Callout>
1717

18-
If you are certain you want to delete a Drupal document, follow the steps below or watch our 16 minute [video](https://drive.google.com/file/d/1eeN9HZT5MCPE_-qx1Ef4AFycsp0O_lLV/view?usp=sharing):
18+
If you are certain you want to delete a document, do this:
1919

20-
1. From your Okta login, locate the document you want to delete on the Docs site, and select **Edit**.
21-
2. Copy all the source HTML and save it to a Jira for safekeeping (in case we need it again).
22-
3. Check whether the doc you want to delete and the doc you want to redirect it to [have both been translated](/docs/new-relic-only/basic-style-guide/writing-guidelines/manage-translated-docs#translation-status). If yes, notify the [Tech Docs team's liaison for translation projects](https://newrelic.jiveon.com/docs/DOC-6596).
23-
4. Copy the following information from the document you plan to delete into a temporary text file:
24-
* In **URL path settings:** Copy the URL alias for the document you are about to delete.
25-
* In the browser address bar: Copy `node/` and the number that follows (for example, `node/10796`).
26-
* In **URL redirects:** Copy each path under **From** (for example, `docs/enable-infinite-tracing)`. (Or, for each existing redirect click **Edit** and update the destination node.)
27-
5. At the bottom of the page, click **Delete**, then confirm the deletion of the file.
28-
6. Go to the document you want to redirect users to, and open it in the Drupal editor.
29-
7. Click **URL redirects**, and then click **Add URL redirect to this content**.
30-
8. Copy the first value from your temporary redirects text file into **From**, and then select **Save**.
31-
9. Repeat this redirect routine, adding the remaining nodes and/or paths to to create individual redirects.
32-
33-
<Callout variant="tip">
34-
If you need additional help with redirect options, see [Create a redirect](/docs/new-relic-only/advanced-style-guide/processes-procedures/rename-redirect-document#redirects).
35-
</Callout>
36-
10. Save the document.
20+
1. Locate the doc you want to delete.
21+
2. Save the doc's content in a file and attach it to an associated Jira (in case we need the doc again).
22+
3. PENDING: INFO ON REDIRECTS
23+
4. Delete the doc and commit change.

src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/embed-videos.mdx

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -21,40 +21,12 @@ Embed videos as an additional aid for readers when appropriate; for example, tip
2121
* New Relic University has its own site: [learn.newrelic.com](https://learn.newrelic.com/).
2222
* Marketing also stores a library of videos at [newrelic.com/resources/videos](https://newrelic.com/resources/videos) and [newrelic.com/resources/webinars](https://newrelic.com/resources/webinars).
2323

24-
Videos are hosted externally and are embedded in the Docs site's page in an inline frame that links to the external source. Official New Relic videos are hosted on [Wistia](//wistia.com). Although Drupal supports embedding from multiple sources, [Vimeo](https://vimeo.com) and [YouTube](https://youtube.com) are the only other video platforms currently enabled.
25-
26-
## Example [#videos]
27-
28-
There are two methods used to embed: a short code method (recommended) and the legacy method. A custom PHP script handles both methods and generates the required markup and scripts to embed the video.
29-
30-
Here is an example of an embedded video:
31-
32-
\[\[wistia|jceickfqyj|optional description]]
33-
34-
Here is an example of the short code you can use to embed a video:
35-
36-
```
37-
[[wistia |video_id|optional_caption]]
38-
```
39-
40-
Here is an example of the longer code to embed a YouTube video in an iframe:
41-
42-
```
43-
<iframe allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/video_id" width="560"&gt;</iframe>
44-
```
45-
46-
Include the running time in the caption so users know if they have time to watch it now or later. For an example, see the [Node.js installation documentation](/docs/agents/nodejs-agent/installation-configuration/install-nodejs-agent#video).
24+
Videos are hosted externally and are embedded in the Docs site's page, linking to the external source. Official New Relic videos are hosted on [Wistia](//wistia.com).
4725

4826
## Procedure
4927

50-
To add an embedded video to a document:
28+
PROCEDURE PENDING...
5129

52-
1. Copy the [short code example](#example) and paste it into your document.
53-
2. Replace the video_id with your video's ID (located in the parent &lt;div> ID of an existing video or in the Wistia UI).
54-
3. Verify the running time, and add a caption by inserting the optional_caption in the short code.
55-
4. For NRU videos, add the following at the end of the caption:
30+
## Example [#videos]
5631

57-
```
58-
View more videos and tutorials at learn.newrelic.com.
59-
```
60-
5. Always test the embedded video before publishing the doc.
32+
EXAMPLE PENDING...

src/content/docs/new-relic-only/tech-writer-style-guide/processes-procedures/publication-checklist.mdx

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ watermark: NR ONLY
1515
This document covers the points that need review when publishing a document, including how to make changes that may be needed for correct publication of a document.
1616

1717
<Callout variant="tip">
18-
Some of these features are available only to admins.
18+
Some of these features are restricted based on permissions.
1919
</Callout>
2020

2121
## Publication checklist [#checklist]
@@ -34,37 +34,6 @@ For new content:
3434

3535
For new documents, make sure:
3636

37-
* The document is living in the right place. See [Renaming and redirecting a document](/docs/new-relic-only/advanced-style-guide/processes-procedures/renaming-redirecting-document).
38-
* The document has the correct permissions assigned to it.
39-
* A description and keywords have been set.
40-
* The sort order is correct.
37+
* The document is living in the right place, and in the right order with other docs. See [Renaming and redirecting a document](/docs/new-relic-only/advanced-style-guide/processes-procedures/renaming-redirecting-document).
38+
* The metadata is correct.
4139

42-
## Check the sort order [#sort-order]
43-
44-
Always confirm sort order when adding or renaming documents. Always use drag and drop to order documents. If items are in order in the **Node order** page but not in the menu, move them out of order and back again. This will force Drupal to renumber all items for that term. This is much easier than worrying about which numbers will and won't work.
45-
46-
<Callout variant="important">
47-
Drag and drop doesn't work if you select **Show row weights**.
48-
</Callout>
49-
50-
Whenever you add a new document or rename an existing doc, Drupal adds to the top list for the assigned taxonomy term. This means it will be the first thing in the menu for that sub-category.
51-
52-
To check the sort order of a document:
53-
54-
1. From the document, select the immediate taxonomy parent in the breadcrumb trail.
55-
2. Select **> Order Nodes**.
56-
3. Make sure the documents are in the right order.
57-
4. Select **Show row weights** to show the row weights.
58-
5. Make sure none are set to zero.
59-
6. Select **Hide row weights** to return to drag and drop interface.
60-
7. Before you check the sort order is the way you want, clear your browser cache.
61-
62-
## Change the sort order [#change-order]
63-
64-
To change the sort order of a document:
65-
66-
1. From the document, select the immediate taxonomy parent in the breadcrumb trail.
67-
2. Select **Order Nodes**.
68-
3. Drag the document to the correct position.
69-
4. Select **Save order**.
70-
5. Before you check the sort order is the way you want, clear your browser cache.

0 commit comments

Comments
 (0)