Skip to main content

Availability

Prerequisites

  • The blog is enabled in your portal configuration (Blog.Enable: true / PORTAL_BLOG_ENABLE=true). See Blog Posts Overview for configuration details.
  • Admin access to the Developer Portal Admin UI.

Create a Blog Post

  1. Open the blog section. In the Admin UI sidebar, select Blog, then click Posts. Developer Portal Admin UI with the Blog section expanded, Posts highlighted in the sidebar, and the Posts list showing existing blog posts
  2. Start a new post. Click Add new Post. Developer Portal Admin UI showing the blank Add Post form after clicking Add new Post
  3. Enter the post title. In the Title field, type the title of your post.
  4. Add a summary. In the Lede field, enter a short summary or introductory paragraph. The Lede is typically displayed on the blog listing page alongside the post title.
  5. Choose your editor. Toggle Display Markdown version to switch between the rich text editor and the Markdown editor.
    • When the toggle is off, use the Content field to write in rich text or HTML.
    • When the toggle is on, use the Markdown Content field to write in Markdown.
    See Markdown in Developer Portal for supported Markdown syntax and limitations.
  6. Set the post status. In the Status field, choose one of:
    New posts default to published. Set the Status field to draft or review before saving if you are not ready to make the post public.
  7. Upload a header image. In the Header Image field, click Choose file… and select an image to use as the featured image for the post.
  8. Set the URL path. In the Path field, enter the URL slug for the post. This becomes part of the public URL: /blog/YYYY/M/D/[path], where the date is derived from when the post is created.
    The post URL’s publish date is set at creation time based on the post’s creation timestamp.
  9. Assign categories. Select one or more categories from the Categories field. Categories group your posts by topic and appear as filters in the Live Portal. To create categories first, see Create and Manage Blog Categories and Tags.
  10. Assign tags. Select one or more tags from the Tags field. Tags control which blog posts appear in the Related blog content section on API Product pages in the Live Portal. To create tags first, see Create and Manage Blog Categories and Tags.
  11. Save the post. Click Save Changes to create the post. Developer Portal Admin UI showing the completed new blog post form with title, lede, and content filled in, before saving
When the post status is set to published, it becomes visible at /blog/YYYY/M/D/[path] in the Live Portal and appears on the blog listing page at /blog. Published blog post as it appears on the Developer Portal Live Portal, showing the title, lede, content, and Recent Posts section

Change a Post’s Status

To unpublish a post, edit the post and change its Status from published to draft or review. The post is removed from the Live Portal immediately. To republish it, set the status back to published.