Skip to content

Commit

Permalink
Add instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rhanajoy authored Apr 24, 2023
1 parent a3e13d6 commit 8ae8158
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"githubPullRequests.ignoredPullRequestBranches": [
"main"
]
}
28 changes: 27 additions & 1 deletion shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,30 @@ The include files may be used for the following values of ms.service:

- dynamics-365
- industry-solutions
- power-platform
- power-platform

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.

1. Create a folder in **MicrosoftDocs/powerapps-docs-pr/shared**.

1. Upload your include file to the folder you created in Step 1.

1. Use the following syntax to insert your include file: `[!INCLUDE [File name](~/../shared-content/shared/filename.md)]`

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)]`

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)]`

## A note about images in include files

Images that should appear in an include file can't be stored in the shared content repo (MicrosoftDocs/powerapps-docs-pr/shared).

Instead, store the image files in **MicrosoftDocs/powerapps-docs-pr/powerapps-docs/media** and call them like this: `source="/power-apps/media/filename.png"`

### Why does the shared content repo live in the powerapps-docs-pr repo?

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.

### Where can I get help with the shared content repo?

Submit a Content Engineering request.

0 comments on commit 8ae8158

Please sign in to comment.