Troubleshooting

If you’re having trouble contributing to Braze Docs, review these common issues first. If the issue you’re experiencing isn’t listed, let us know so we can add it here.

Redirect isn’t working

If a redirect you set up in the global redirect file (assets/js/broken_redirect_list.js) isn’t working, double-check your URL string for any uppercase characters. If you find any, convert them to lowercase (even if the corresponding filename in the _docs directory contains uppercase characters).

• before
• after

1
validurls['/docs/hidden/WIP_Partnerships/WIP_Guidelines'] = '/docs/contributing/home/';

1
validurls['/docs/hidden/wip_partnerships/wip_guidelines'] = '/docs/contributing/home/';

Cross-reference link returns a 404

If a cross-reference link on your page (such as [Braze Developer Guide]({{site.baseurl}}/developer_guide/home)) returns a 404 page, check the URL for the following string.

1
%7B%7Bsite.baseurl%7D%7D

A URL containing this string will be similar to the following:

1
https://www.braze.com/docs/user_guide/personalization_and_dynamic_content/connected_content/%7B%7Bsite.baseurl%7D%7D/user_guide/administrative/app_settings/message_activity_log_tab

If you find this string in the URL, one or more of your cross-reference links are surrounded in Liquid raw tags.

• liquid raw tag

Move these tags so that they’re only surrounding the Liquid content you want to display as raw.

• before
• after

Conflict: Destination is shared by multiple files

If rake throws the following warning, this means that two or more files are sharing the same permalink YAML value.

1
2
3
4
5
Conflict: The following destination is shared by multiple files.
                    The written file may end up with unexpected contents.
                    /Users/USERNAME/braze-docs/_site/api_usage/index.html
                     - /Users/USERNAME/braze-docs/_docs/_developer_guide/platforms/android.md
                     - /Users/USERNAME/braze-docs/_docs/_developer_guide/platforms/firos.md

To fix this, change the permalink value of one of the files, so they’re no longer set to the same URL. For example:

• before
• after

1
2
3
4
5
6
7
8
---
nav_title: Android
permalink: /docs/developer_guide/best_sdk
---

# The Android Braze SDK

> Get started with the Braze Android SDK!

1
2
3
4
5
6
7
8
---
nav_title: FireOS
permalink: /docs/developer_guide/best_sdk
---

# The FireOS Braze SDK

> Get started with the Braze Android SDK!

1
2
3
4
5
6
7
8
---
nav_title: Android
permalink: /docs/developer_guide/best_sdk
---

# The Android Braze SDK

> Get started with the Braze Android SDK!

1
2
3
4
5
6
7
8
---
nav_title: FireOS
permalink: /docs/developer_guide/second_best_sdk
---

# The FireOS Braze SDK

> Get started with the Braze Android SDK!

Can’t choose braze-inc/braze-docs as a base repository

If braze-inc/braze-docs is missing from the list of available base branches when making a change in GitHub, there may be an issue with the origin of your forked repository.

Step 1: Verify the fork’s origin

Go to your forked repository and verify it was forked from braze-inc/braze-docs. If it isn’t, you’ll need to delete this fork and create a new one.

Step 2: Delete the old fork

In your old fork, go to Settings > General. Under Danger Zone, select Delete this repository and follow the on-screen instructions.

Step 3: Create a new fork

Go back to the official Braze Docs GitHub repository, then select Fork to create a new fork.

Keep the default settings, then select Create fork. Now you’ll be able to choose braze-inc/braze-docs as the base repository when making changes in GitHub.