You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix Vale style errors in instance audiences documentation
- Replace audience(s) with audiences for clarity
- Change 'does not' to 'doesn't' per Microsoft.Contractions
- Capitalize 'API Reference' per FernStyles.Reject
- Replace 'Latest/latest' version names with v3/v2 to avoid time-relative terms
Co-Authored-By: Catherine Deskur <[email protected]>
Copy file name to clipboardExpand all lines: fern/products/docs/pages/navigation/instance-audiences.mdx
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,17 +11,17 @@ Instance audiences allow you to control which versions and products are included
11
11
12
12
You can add audiences to three levels in your `docs.yml` configuration:
13
13
14
-
1.**Instances** - Define which audience(s) an instance serves
15
-
2.**Versions** - Tag versions with audience(s) they belong to
16
-
3.**Products** - Tag products with audience(s) they belong to
14
+
1.**Instances** - Define which audiences an instance serves
15
+
2.**Versions** - Tag versions with audiences they belong to
16
+
3.**Products** - Tag products with audiences they belong to
17
17
18
-
When you add an audience to a product or version and it matches the audience of the instance, that content will be included. If the audience is defined but does not match the instance audience, it will be excluded. If no audience is defined, all content will be included by default.
18
+
When you add an audience to a product or version and it matches the audience of the instance, that content will be included. If the audience is defined but doesn't match the instance audience, it will be excluded. If no audience is defined, all content will be included by default.
19
19
20
20
## Configuration
21
21
22
22
### Add audiences to instances
23
23
24
-
Define which audience(s) an instance serves by adding the `audiences` property to an instance in your `docs.yml`:
24
+
Define which audiences an instance serves by adding the `audiences` property to an instance in your `docs.yml`:
25
25
26
26
<CodeBlocktitle="docs.yml">
27
27
```yaml {3-4}
@@ -42,12 +42,12 @@ Tag versions with audiences to control which instances include them:
42
42
<CodeBlock title="docs.yml">
43
43
```yaml {4-5, 8-9}
44
44
versions:
45
-
- display-name: Latest
46
-
path: ./versions/latest.yml
45
+
- display-name: v3
46
+
path: ./versions/v3.yml
47
47
audiences:
48
48
- public
49
-
- display-name: Beta
50
-
path: ./versions/beta.yml
49
+
- display-name: v2
50
+
path: ./versions/v2.yml
51
51
audiences:
52
52
- internal
53
53
- beta
@@ -79,7 +79,7 @@ products:
79
79
The filtering logic works as follows:
80
80
81
81
- **Match**: If a version or product has an audience defined that matches the instance audience, it will be included
82
-
- **No match**: If a version or product has an audience defined that does not match the instance audience, it will be excluded
82
+
- **No match**: If a version or product has an audience defined that doesn't match the instance audience, it will be excluded
83
83
- **No audience defined**: If no audience is defined on a version or product, it will be included in all instances
Instance audiences work alongside [API reference audiences](/docs/api-references/audiences), which filter endpoints and schemas within your API documentation. You can use both features together:
163
+
Instance audiences work alongside [API Reference audiences](/docs/api-references/audiences), which filter endpoints and schemas within your API documentation. You can use both features together:
164
164
165
165
- **Instance audiences** - Control which products and versions appear in each instance
166
-
- **API reference audiences** - Control which endpoints and schemas appear within API references
166
+
- **API Reference audiences** - Control which endpoints and schemas appear within API References
167
167
168
-
For example, you might have a public instance that includes only public products, and within those products, the API references are further filtered to show only public endpoints.
168
+
For example, you might have a public instance that includes only public products, and within those products, the API References are further filtered to show only public endpoints.
0 commit comments