Skip to content

Commit

Permalink
Merge pull request #8312 from braze-inc/fixing-doc-templates
Browse files Browse the repository at this point in the history
Fixing misc. docs templates issues
  • Loading branch information
rachel-feinberg authored Oct 28, 2024
2 parents 85282c0 + 2af6a36 commit d7c116e
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion _includes/contributing/templates/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: "SHORT_DESCRIPTION."
alias: /OPTIONAL_SHORT_ARTICLE_TITLE/
page_type: reference
layout: OPTIONAL_LAYOUT_FILE
---

<!-- The title of your page, used to render the in-page title. -->
# ARTICLE_TITLE
Expand Down
2 changes: 1 addition & 1 deletion _includes/contributing/templates/explanation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "SHORT_DESCRIPTION."
alias: /OPTIONAL_SHORT_ARTICLE_TITLE/
page_type: reference
layout: OPTIONAL_LAYOUT_FILE
--
---

# ARTICLE_TITLE

Expand Down
2 changes: 1 addition & 1 deletion _includes/contributing/templates/how_to_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "SHORT_DESCRIPTION."
alias: /OPTIONAL_SHORT_ARTICLE_TITLE/
page_type: reference
layout: OPTIONAL_LAYOUT_FILE
--
---

# ARTICLE_TITLE

Expand Down
2 changes: 1 addition & 1 deletion _includes/contributing/templates/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "SHORT_DESCRIPTION."
alias: /OPTIONAL_SHORT_ARTICLE_TITLE/
page_type: reference
layout: OPTIONAL_LAYOUT_FILE
--
---

# ARTICLE_TITLE

Expand Down
11 changes: 5 additions & 6 deletions _includes/contributing/templates/technology_partner.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,12 @@ description: "SHORT_DESCRIPTION."
alias: /partners/PARTNER_NAME/
page_type: partner
search_tag: Partner
layout: dev_guide
---

<!-- In most cases, the ARTICLE_TITLE will be your company name. If your tool requires several seperate pages on Braze Docs, you can add a relevant page descriptor to your title, such as "MyCompany Analytics." -->
<!-- In most cases, the ARTICLE_TITLE will be your company name. If your tool requires several separate pages on Braze Docs, you can add a relevant page descriptor to your title, such as "MyCompany Analytics." -->
# ARTICLE_TITLE

<!-- The description starts with a '>' character and contains an introduction to your company, a link to your main site, and a consice overview of your integration. In a following paragraph, highlight the the relationship between your company and Braze and how this partnership helps your customers. -->
<!-- The description starts with a '>' character and contains an introduction to your company, a link to your main site, and a concise overview of your integration. In a following paragraph, highlight the the relationship between your company and Braze and how this partnership helps your customers. -->
> DESCRIPTION.

ADDITIONAL_INFORMATION.
Expand All @@ -42,7 +41,7 @@ If you are using the [older navigation]({{site.baseurl}}/navigation), you can cr

CONTENT.

<!-- Create step-by-step instructions for integrating your tool with Braze. It's important to be concise and only outline the minimum neccesary steps. -->
<!-- Create step-by-step instructions for integrating your tool with Braze. It's important to be concise and only outline the minimum necessary steps. -->
## Integrating TOOL_NAME

CONTENT.
Expand Down Expand Up @@ -87,7 +86,7 @@ CONTENT.

CONTENT.

<!-- An optional section you can use to outline additional customization steps. It's important to be concise and only outline the minimum neccesary steps. -->
<!-- An optional section you can use to outline additional customization steps. It's important to be concise and only outline the minimum necessary steps. -->
## Customizing TOOL_NAME

### Step 1: ACTION_TO_COMPLETE
Expand All @@ -98,7 +97,7 @@ CONTENT.

CONTENT.

<!-- A section outlinning how to use your integration with Braze. For example: how to access the data sent to Braze, or how to leverage your integration with Braze messaging. -->
<!-- A section outlining how to use your integration with Braze. For example: how to access the data sent to Braze, or how to leverage your integration with Braze messaging. -->
## Using TOOL_NAME with Braze

### Step 1: ACTION_TO_COMPLETE
Expand Down
2 changes: 1 addition & 1 deletion _includes/contributing/templates/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "SHORT_DESCRIPTION."
alias: /OPTIONAL_SHORT_ARTICLE_TITLE/
page_type: tutorial
layout: OPTIONAL_LAYOUT_FILE
--
---

# Tutorial: WHAT_THE_USER_WILL_DO

Expand Down

0 comments on commit d7c116e

Please sign in to comment.