Skip to content

Commit 8ae8158

Browse files
authored
Add instructions
1 parent a3e13d6 commit 8ae8158

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

.vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"githubPullRequests.ignoredPullRequestBranches": [
3+
"main"
4+
]
5+
}

shared/README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,30 @@ The include files may be used for the following values of ms.service:
44

55
- dynamics-365
66
- industry-solutions
7-
- power-platform
7+
- power-platform
8+
9+
Full instructions for [using include files](/help/platform/includes-best-practices?branch=main) are in the Learn contributors guide. Here's a quick summary of how to use the shared content repo for BAP Skilling include files.
10+
11+
1. Create a folder in **MicrosoftDocs/powerapps-docs-pr/shared**.
12+
13+
1. Upload your include file to the folder you created in Step 1.
14+
15+
1. Use the following syntax to insert your include file: `[!INCLUDE [File name](~/../shared-content/shared/filename.md)]`
16+
17+
The following example inserts the file gdpr-intro.md, which is stored in the folder **shared/privacy-includes**: `[!INCLUDE [gdpr-intro](~/../shared-content/shared/privacy-includes/gdpr-intro.md)]`
18+
19+
The following example inserts a lightbox accessibility tip, which is stored at the root level of the **shared** folder: `[!INCLUDE [Lightbox tip](~/../shared-content/shared/lightbox-tip.md)]`
20+
21+
## A note about images in include files
22+
23+
Images that should appear in an include file can't be stored in the shared content repo (MicrosoftDocs/powerapps-docs-pr/shared).
24+
25+
Instead, store the image files in **MicrosoftDocs/powerapps-docs-pr/powerapps-docs/media** and call them like this: `source="/power-apps/media/filename.png"`
26+
27+
### Why does the shared content repo live in the powerapps-docs-pr repo?
28+
29+
It's a long story. The TL;DR: is that powerapps-docs-pr is already set up for all the languages we localize our docs in. Lots of extra work would have been required to localize files stored in, say, MicrosoftDocs/reusable-content.
30+
31+
### Where can I get help with the shared content repo?
32+
33+
Submit a Content Engineering request.

0 commit comments

Comments
 (0)