Skip to content

Commit eda9e21

Browse files
[Updated] Before You Begin section (linode#6976)
* [Updated] Linode Writer's Formatting Guide - Before You Begin section * edited Before You Begin in content.md archetype * Edits to the Before You Begin section * Spelling fix --------- Co-authored-by: Matthew Wildman <matt@wildman.online>
1 parent 09b350e commit eda9e21

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

archetypes/content.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ When writing content, please reference the [Linode Writer's Formatting Guide](ht
1717

1818
## Before You Begin
1919

20-
1. If you have not already done so, create a Linode account and Compute Instance. See our [Getting Started on the Linode Platform](/docs/products/platform/get-started/) and [Create a Compute Instance](/docs/products/compute/compute-instances/guides/create/) guides.
20+
In this section, list out any prerequisites necessary for the reader to complete the guide, including: services or products to be created beforehand, hardware and plan requirements, or software that needs to be preinstalled.
2121

22-
1. Follow our [Setting Up and Securing a Compute Instance](/docs/products/compute/compute-instances/guides/set-up-and-secure/) guide to update your system. You may also wish to set the timezone, configure your hostname, create a limited user account, and harden SSH access.
23-
24-
{{< note >}}
25-
The steps in this guide require root privileges. Be sure to run the steps below as `root` or with the `sudo` prefix. For more information on privileges, see our [Linux Users and Groups](/docs/guides/linux-users-and-groups/) guide.
26-
{{< /note >}}
22+
See: [Linode Writer's Formatting Guide: Before You Begin](http://www.linode.com/docs/guides/linode-writers-formatting-guide/#before-you-begin)

docs/guides/linode-writers-formatting-guide/index.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: 'This guide provides formatting and style guidelines for documentat
55
authors: ["Linode"]
66
contributors: ["Linode"]
77
published: 2014-01-15
8-
modified: 2024-04-18
8+
modified: 2024-05-29
99
keywords: ["style guide", "format", "formatting", "how to write", "write for us", "write for linode", "linode docs", "submissions"]
1010
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
1111
aliases: ['/linode-writers-formatting-guide/','/linode-writers-guide/','/style-guide/']
@@ -74,12 +74,24 @@ Introductions should be concise; explain what the goal of the guide is and why.
7474

7575
### Before You Begin
7676

77-
The *Before You Begin* section is an area for basic prerequisites a reader should know or have completed before proceeding further in your guide. Use the example below and edit as needed:
77+
The *Before You Begin* section is used to inform the reader of any prerequisites needed to successfully complete the guide. This may include the following:
7878

79-
```file {title="Author Submission"}
79+
- Specific Akamai services or features that are needed, like Compute Instances, LKE clusters, or Object Storage buckets. This should include any hardware or plan requirements (see [Pricing](https://www.linode.com/pricing/)).
80+
81+
- Setup tasks on Akamai services, such as securing a Compute Instance, creating a limited user, configuring a hostname. Only include tasks that are related to the guide and the guide's objective.
82+
83+
- External requirements, such as a registered domain name or specific local software (such as a PC running Windows 11).
84+
85+
- Software or applications that need to be installed or configured (i.e. LAMP stack, Docker, etc.), making sure to include links to instructions. Only include software that is directly used within the guide, but is not the focus of the guide. If the software needs additional configuration or usage information, it should likely be included in the guide's instructions and not in the *Before You Begin* section.
86+
87+
- Foundational knowledge, like an understanding of technology fundamentals (like container orchestration) or specific software or software stacks (like Kubernetes).
88+
89+
Below is an example *Before You Begin* section. You may copy the example and edit it as needed:
90+
91+
```file {title="Before You Begin"}
8092
## Before You Begin
8193
82-
1. If you have not already done so, create a Linode account and Compute Instance. See our [Getting Started with Linode](/docs/products/platform/get-started/) and [Creating a Compute Instance](/docs/products/compute/compute-instances/guides/create/) guides.
94+
1. If you do not already have a virtual machine to use, create a Compute Instance with at least 4 GB of memory. See our [Getting Started with Linode](/docs/products/platform/get-started/) and [Creating a Compute Instance](/docs/products/compute/compute-instances/guides/create/) guides.
8395
8496
1. Follow our [Setting Up and Securing a Compute Instance](/docs/products/compute/compute-instances/guides/set-up-and-secure/) guide to update your system. You may also wish to set the timezone, configure your hostname, create a limited user account, and harden SSH access.
8597
```

0 commit comments

Comments
 (0)