This guide shows you how to set up and customize a public-facing changelog page for your Userorbit Admin Panel.
Before You Begin
- Access to the Userorbit Admin Panel.
- An existing Userorbit workspace.
- (Optional) A custom domain if you plan to use one for your changelog.
- (Optional) A logo and brand colors for customization.
Steps
- Enable the Public Changelog — Navigate to the Announcements section within your Userorbit Admin Panel. Look for settings related to public changelogs or announcements and activate the feature to make your changelog accessible to the public.
- Locate Your Changelog URL — Once enabled, your public changelog will have a default URL, typically in the format of
yourworkspace.userorbit.com/changelog. This URL will be displayed in the changelog settings. If you have a custom domain configured for your workspace, it might also be available there. - Customize the Changelog Page — Within the changelog settings, you'll find options to customize its appearance. This usually includes uploading your company logo, selecting brand colors, and choosing a layout that matches your website's aesthetic.
- Configure SEO Settings — To improve search engine visibility for your changelog, access the SEO settings section. Here you can set a unique meta title (under 60 characters) and a concise meta description (under 160 characters) that accurately describe your changelog content.
- Embed or Link Your Changelog — Decide how you want to present your changelog on your existing website. You can either embed it directly using an iframe code provided by Userorbit or simply add a link button that directs users to your standalone changelog page.
- Control Collection Visibility — Userorbit allows you to organize your announcements into collections. In the changelog settings, you can specify which of these collections should be visible on your public changelog page, giving you control over what content is shared publicly.
- Use a Custom Domain (Optional) — If you prefer to host your changelog on your own domain (e.g.,
changelog.yourcompany.com), follow the instructions provided in Userorbit's settings to configure DNS records (like CNAME) to point your custom domain to the changelog page.
Verify It Worked
After completing the steps, perform the following checks:
- Visit your public changelog URL (default or custom domain) in an incognito browser window to ensure it is live and displays all content correctly.
- Confirm that your customizations, such as the logo, brand colors, and layout, are applied as intended.
- Check that only the announcement collections you selected are visible on the public page.
- If you configured a custom domain, verify that the changelog loads correctly when accessed through that domain.
- If you embedded or linked the changelog on your website, ensure it functions as expected from your site.