Skip to content

Commit 5f91b48

Browse files
supergranularCopilotCopilot
authored
Adding new content type - Get started (#60809)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent ec7cc2d commit 5f91b48

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Get started content type
3+
intro: Get started content provides the minimal essential information to use a product or feature.
4+
versions:
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
8+
category:
9+
- Follow the style guide and content model
10+
---
11+
12+
Get started content provides an entry point into using GitHub products and features. This section should contain only the minimum essential information a user needs before they move on to concepts and how-tos. We do this to be concise, and also so it doesn't seem complicated just to get started with a feature.
13+
14+
## Get started considerations
15+
16+
Get started is a set of articles which should be easy and fast to scan. It should contain fewer than 5 articles, and ideally only two:
17+
* Quickstart
18+
* About [PRODUCT] (or “What is [PRODUCT]”)
19+
20+
The one exception to this may be with available plans and billing information, where such information is required to use the product or feature.
21+
22+
For more information on quickstart content, see [AUTOTITLE](/contributing/style-guide-and-content-model/quickstart-content-type).
23+
24+
In particular, articles with this information do not belong in Get started:
25+
* Articles that fall under the how-to content type.
26+
* Set up or sign up steps: these are also how-tos. They document how to do something in the UI.
27+
* Content that is useful for getting started with a particular feature but not the whole product area. This kind of content more properly belongs in Concepts.
28+
* Best practices, generally. Users new to a feature lack the context necessary to make the most of these.
29+
30+

content/contributing/style-guide-and-content-model/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ children:
1414
- /how-to-content-type
1515
- /troubleshooting-content-type
1616
- /release-note-content-type
17+
- /get-started-content-type
1718
- /quickstart-content-type
1819
- /tutorial-content-type
1920
- /about-combining-multiple-content-types

0 commit comments

Comments
 (0)