Skip to content
Documentation

    Writing and Managing Posts

    Whether you are writing an update for a single change, or a release summary for the past week. Creating a post is easy and fast with Hub.

    To create a new Post,

    1. Click the Create post button in the top right corner of the Changelog page.

    2. A post can include work items from one or multiple projects. If you want to add additional projects, you can configure them in the Changelog filter settings.

    3. Click the Get started button to create a draft and start editing.

    Available filters

    Select which work items you want to include in the post.

    FilterDescription
    Resolved since Include work items resolved since a specific date.
    VersionInclude work items with a specific version.
    LabelInclude work items with a specific label.
    Work item typeInclude specific types of work items.
    Jira FilterInclude work items that match a given Jira filter.

    After creating a new post, you can start with a blank page or use a template (if one is set up for the portal).

    You can always write your update manually in the editor — but if you’d like help from AI, we recommend following these steps to craft a polished update more efficiently.

    1. Select one ore more work items in the right-hand staging area. Once selected, an action toolbar will appear at the top of the sidebar. Click the Generate button to generate the descriptions for the selected work items.

      To select multiple work items at once:

      • Press Cmd/Ctrl and click on multiple work items.
      • Click to select the first work item. Then press Shift and click the last work item. This will select the first work item, the last work items, and all work items in between.
    2. Once you’ve generated changelog descriptions for your work items, you can drag individual items into the editor — or select and insert multiple items at once.

      Each inserted item will include its AI-generated description along with a direct link to the original work item.

    3. After inserting the generated descriptions, you can freely edit the content in the editor to make it your own. Refine the wording, adjust the tone, or add extra context. You can also embed rich media — such as images, GIFs, YouTube or Loom videos — to bring your updates to life.

    To create a post from a template, choose one of the available templates in the empty state of editor. A dialog will appear showing the template’s name and the number of issues it will include.

    Based on the template setup, the AI copywriter will create a title, intro, and description for each issue in the post. After the post is generated, you can edit the text in the editor and add images and videos.

    Learn more about templates.

    If you need to edit a post once published, you can easily update the post.

    Simply click on Edit in on a post, make your changes and publish the post again.

    If you published a post to the wrong channel, you can disable the channel when updating the post, and it will be retracted from that channel.

    You can delete a post from via the post editor.

    • Click to edit a post.
    • Click the Unpublish button in the top bar of the editor.
    • Once unpublished, click the Discard draft button in the top bar of the editor to completely delete the post.

    When you create a new post or make edits to an existing one, a draft is automatically generated, ensuring that you can conveniently resume your work at a later time.

    To edit a previously created draft, navigate to the Changelog section in your Space. All current drafts can be found at the top of the overview page.

    Click on a draft to start editing.

    Drafts are saved automatically as you type.

    To delete a draft, click the Discard draft button in the top bar of the editor. Keep in mind that discarding a draft only deletes unpublished content.

    AI generation work item limit

    The generation of descriptions is limited to a maximum of 50 work items at a time. In case you have a larger number of work items, it is recommended to select and generate the descriptions in smaller batches.

    AI generation token limit

    Consider tokens as fragments of words. Before the API tackles your prompts, it disassembles the input into these tokens. It’s worth noting that tokens don’t align perfectly with the beginnings or endings of words - they might encompass trailing spaces or parts of words. To understand the concept of token lengths, here are a few useful guidelines:

    • 1 token ~= 4 chars in English
    • 100 tokens ~= 75 words
    • 2048 tokens ~= 1,500 words

    Requests can use up to 4097 tokens shared between prompt and completion. If your prompt is 4000 tokens, your completion can be 97 tokens at most. Therefore we enforce a limit on the size of the prompt, which includes the work item description.

    As newer models with increased limits become available, we will be upgrading our limits as well.