Web Spotlight is the way to go for Kontent.ai projects used for a website. When you start fresh, you just start using it and don’t need to deal with any migration. But what about using Web Spotlight for an already existing enterprise project?
This lesson will guide you through the Web Spotlight migration project, focusing on the content modeling
part. Migrating to Web Spotlight requires some development. The
development complexity depends on how you approach navigation now
and, therefore, how many changes you’ll need to make.
The better planned out your transition is, the fewer issues you’ll need to solve on the go. Write down notes of your action plan. If unsure, consult with our support.
You most likely want your website with as short an outage as possible. Therefore, you’ll need to support both old and new navigation for some time. We recommend using an environment variable that signifies which navigation is used in the environment.
Before you continue to the next step, ensure people you need for this transition have time to do their part. You’ll make changes to the following:
Content model (and project configuration in general) to make changes outlined in the following steps.
Development code to incorporate changes in the content model.
Content creation process to reflect authoring through Web Spotlight.
In this step, make sure you’ll adjust your project in a non-production environment.
(Optional) Create a project backup – clone your project and archive the cloned copy. It’s not required, but just to be extra careful.
Because Kontent.ai is versatile, there are multiple ways to build navigation. Web Spotlight works with the navigation modeled in Kontent.ai according to our best practice for navigation. That means you model the page tree via the content model, and your content creators can edit it based on their permissions.
You can use both described approaches – bind content to navigation or separate them. We recommend using the separate (2-item) approach as it’s better for more extensive projects prepared for omnichannel content. Moreover, Web Spotlight makes this approach more user-friendly. When editing items, it automatically opens the correct content item.
Take this also as an opportunity to adjust your navigation if it doesn’t satisfy all your needs.
Once you activate Web Spotlight, you’ll find a new item named Homepage in your project. It comes with two elements, Content and Subpages.
In the Subpages element, link pages to define your website’s top-level navigation.
The Content element is a linked item element and specifies what content is displayed on the homepage.
If you already have a content type and a content item for the homepage, adjust the newly created homepage to reflect the old one.
Web Spotlight creates the Page type for pages. However, using your original navigation in an existing project will be much easier.
Ensure your navigation content types use the Subpages element instead of the Linked items element. Create the Subpages element manually for all content types where it makes sense. If you have a lot of content, use the data-ops tool to help you with these tasks.
Since you’ve changed the content model, some of your content may end up under different URLs after adopting Web Spotlight. If you’re a heavy cross-linker, this could lead to lots of 404s, especially if caching plays against you.
If you don’t have any support for setting redirects yet, consider whether you need to create redirect rules directly in Kontent.ai. Discuss suitable approaches to avoid 404s with your technical staff.
After you finish changes to your content model, ensure your code supports the new elements. As subpages work similarly to linked items, you’ll only make a few adjustments.
Then, test your navigation in a non-production environment. Test the navigation from both the external and internal points of view. The navigation must work for your customers, and your authoring team needs to be able to easily set the page tree structure.
Once the process is complete, publish your updated code to production.
When the right time comes, switch to the new navigation in your app. Typically, you’ll change the environment variable specifying which navigation is used and restart your application. However, specific actions can vary in different setups.
Before you close this project as another notch on your belt, devote some time to clean up. Keeping your content model and code tidy will help you with your future endeavors. Again, use a separate environment to test that your clean-up doesn’t break anything.Remove unused elements and content types that were working for the old navigation. You can remove its logic; you won’t need it anymore. You can also remove the Page content type if you used your content types for the original navigation.
Sign in with your Kontent.ai credentials or sign up for free to unlock the full lesson, track your progress, and access exclusive expert insights and tips!
Migrate an existing project to use Web Spotlight | Kontent.ai Learn
Key takeaways
Planning is the key to a successful transition to Web Spotlight. Map out all the upcoming changes.
Add subpages to your existing navigation. It’s likely easier than adjusting the predefined content type to your liking.
Both old and new navigation approaches need to work for some time to prevent downtimes.
Don’t forget to train your colleagues and do a clean-up at the end.
You can follow these steps to migrate your existing project to use live preview with spaces.
Using an already established non-production environment?You can use your already existing non-production environment if preferred. It will speed some actions up. For example, you don’t need to spend time with additional deployment. However, getting Web Spotlight up and running in a larger project can take some time.If you’re not sure you can focus 100% on this transition, you may want to publish other updates in the meantime. In such a case, we recommend using another environment where you can deal with Web Spotlight without any disruptions.
Not using navigation modeled in Kontent.ai?If you’re using a different type of navigation, create the whole navigation logic as you would for a new project. We recommend going through the content modeling guide first and following this tutorial later.
When to use the tightly-bound navigation?Keeping your content and navigation in one content item is a more straightforward option. It means that the items you see in the Web Spotlight page tree hold both their place in navigation and the content itself. Use it for single-purpose, simple, or learning projects.
What about localization?If you have a multilingual website, create the page tree in one language first and then migrate the subpages to other languages. Use data-ops for this task as well. This way, you’ll establish a common page tree across your multilingual project and adjust the page titles for each language.
Tomas Nosek
9 minutes
Web Spotlight
to help you with these tasks.
