Module Assessment | Yext Hitchhikers Platform

Background

The Turtlehead Tacos team has built up their Content, Pages, and Search experiences. Now they want to create a blog site that’s unrelated to anything you’ve built so far. Typically you can use your brand’s existing account, but we’ll use a new account since we won’t use anything existing. Instead of starting from scratch, like you did in the other tracks, you want to install the Blog Starter Template as your starting point.

Your Challenge

When you generate your challenge account, note that your account is empty. Remember, this is a new starting point with a fresh account.

1. Navigate to Apps > Solutions.

2. Click on the Blog Starter Template.

3. Click to View Solution to view the template’s configuration files in the Admin Console and to start the installation flow.

4. Once in the Admin Console, click into a few files from the directory on the left to become more familiar with the template. Try to find the following files and take a look:

   • km/entity-type/blog.json - This is the file for the Blog entity type configuration. You’ll see metadata like the entity type’s display name and plural name.

   • km/field-eligibility-group/blog.json - This file specifies the fields found on the blog entity type and which ones are required (none in this case).

   • km/field/blogAuthor.json- This is the file for the Blog Author custom field. You can see the field is using the field type string.

   • km/entity/2904357900551428226.json- This is the file for a sample blog entity. You can see all the content that is filled in for this entity.

   • pages/yextsite-config/blog-starter-react.json - This is the file for your Pages site. You can see things like the site’s name and the staging site’s credentials. The repoConfig property links to another file (pages/repository/acutely-commuting-panda-9471t.json), which shows the Github template repository used to generate the new repository you’re creating and the URL you want that repo to live at. You’ll learn more about this in step 9.

   Feel free to click around to see even more.

5. You decide that you want to modify the files before you apply them, which you are always welcome to do! Remember that any changes that you make in your browser won’t impact the global solution template – they’re just saved locally in your browser. Navigate to the km/entity-type/blog.json file and add in a description for the Blog entity type:

   This entity type stores blog entries for our brand, including fields like author, body, and metadata.

6. When you’re ready, click the Apply button in the top right corner of the screen.

7. Enter your account ID of your challenge account. You can find this in the URL path (e.g., /s/[[accountID]] in the URL of your account or by navigating to Account Settings > Personal Settings and searching for Account ID). You can leave the Namespaces field empty. Click Continue.

8. Now you need to authenticate into your account. Click the link to “Start Authorization Flow”. Once authorized, close the tab and then click Continue.

9. The solution contains a variable for the businessId. This is used to set the GitHub repository name for your Pages site repository as github.com/yext-pages/blog-starter-${{businessId}}.

   • This is the same name you would provide if you clicked Create Repository within your selected site after navigating to Pages > All Sites. businessId is the same as account ID. Like in step 7, you can find your account ID in the URL or by navigating to Account Settings > Personal Settings and searching for Account ID field.

10. You’ll be prompted to View Diffs to review the changes you will be applying to your account. Click into a few files. Specifically, look at:

    • An example of adding a new file: blogStarter/km/entity-type/blog.json
    • An example of updating a file: default/km/settings.json

    If you see something on the diff that you don’t want to apply, you can click cancel and modify the files in the Admin Console. Otherwise, click Continue.

11. Review your changes one last time. Click Confirm to proceed.

12. Monitor the application in the console. If there are any errors, review the error message and take any necessary actions. If you aren’t sure, reach out to hitchhikers-support@yext.com or post in the Community .

13. Once you get the “Successfully applied resources” message, go back to your account and check out:

    • New entity types in your account by visiting the Configuration > Entity Types screen
    • New sample entities by navigating to Content > Entities
    • New Pages site by navigating to Pages > All Sites