---
seo:
  title: "Publishing to your Portal"
  description: "What happens to your Developer Portal when you publish a version of a document, and how many documents share one portal."
llm_context: "Guide for specification authors explaining how publishing a document version updates the Developer Portal: how documents are organised by issuer, market, document and version, what is replaced and what is preserved on each publish, and how to check the result."
category: "guide"
---

## Publishing to your Portal

When you click **Publish Version** on a document, the platform creates a new published revision exactly as it always has. If your organisation also has a Developer Portal, that same click now sends the document to the portal for you — pages, images, downloads and navigation included.

This guide explains what ends up on the portal, how several documents live side by side there, and what is (and is not) changed each time you publish.

:::info No portal?
If your organisation does not have a Developer Portal, nothing changes. Publishing creates the revision and adds it to the document timeline as before.
:::

### Versions and revisions

It helps to be clear on two terms first:

- A **version** is the two-part number you work on, such as `5.4`.
- A **revision** is created each time you publish that version: `5.4.1`, then `5.4.2`, and so on.

The portal shows **one set of pages per version**, always reflecting its most recent revision. Publishing `5.4.2` replaces the `5.4` pages that `5.4.1` created; readers never have to choose between revisions. The downloadable files, however, are kept for every revision — see [What is kept for every revision](#what-is-kept-for-every-revision).

### One portal, many documents

A portal is shared by every document you publish, so each one is given its own place based on four things you already manage in the platform:

1. the **issuer**,
2. the **market**,
3. the **document**, and
4. the **version**.

```treeview
├── acme-exchange/                  # Issuer
│   ├── equities/                   # Market
│   │   ├── trading-fix-spec/       # Document
│   │   │   ├── 5-3/                # Version 5.3
│   │   │   └── 5-4/                # Version 5.4
│   │   └── drop-copy/              # Another document in the same market
│   │       └── 1-0/
│   └── derivatives/                # Another market
│       └── trading-fix-spec/
│           └── 2-1/
```

This is also the address readers see: version `5.4` of the document above lives at `/acme-exchange/equities/trading-fix-spec/5-4`.

Because every document version has its own place, **publishing one document never alters another**. Publishing the Drop Copy specification leaves the Trading specification's pages, images and downloads exactly as they were.

:::info Documents without a market
A document that is not assigned to a market is placed under a market called **All Documents**.
:::

### What happens when you publish

Each publish does the following for the version you published, and only that version:

| On the portal               | What happens                                                                                                           |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Pages**                   | Each top-level section of your document becomes a page. The version's pages are rebuilt to match the document exactly. |
| **Section menu**            | The left-hand menu for the version is rebuilt to list those pages, in the order of your document.                      |
| **Messages and components** | Messages, components and views placed in your sections are rendered live from the published specification.             |
| **Images**                  | Images you uploaded into the document are copied to the portal. Images linked from elsewhere on the web stay as links. |
| **Downloads**               | The FinSpec file, the PDF and (for FIX documents) the QuickFIX dictionary for the new revision are added.              |
| **Portal navigation**       | The issuer, market and document are added to the portal's menus if they are not already there. See below.              |

"Rebuilt to match the document exactly" means the portal follows your document in both directions:

- a section you **added** appears as a new page,
- a section you **renamed or removed** disappears from the portal,
- a section with **no content** is left out, and
- an image you **no longer use** is removed.

:::tip
Treat the pages of a published version as owned by the platform. Any change made to those pages directly on the portal will be replaced the next time that version is published — make the change in the document instead.
:::

### What is kept for every revision

Pages show only the latest revision of a version, but the downloadable files are kept for each one. After publishing version `5.4` twice you will have:

| Revision | Pages on the portal    | Downloads kept         |
| -------- | ---------------------- | ---------------------- |
| `5.4.1`  | Replaced by `5.4.2`    | FinSpec, PDF, QuickFIX |
| `5.4.2`  | Shown as version `5.4` | FinSpec, PDF, QuickFIX |

If you uploaded your own PDF when publishing, that file is used instead of a generated one. A QuickFIX dictionary is only produced for FIX documents which have both a header and a trailer defined.

### Working on more than one version

When you start a new version (say `5.5`) and publish it, it gets its own set of pages alongside `5.4`; the older version's pages remain available at their own address.

The portal's menus and landing page always point readers at the **newest version** of each document. Re-publishing an older version refreshes that version's pages but never moves those links backwards.

### How your portal's navigation is updated

Three pieces of navigation are shared between documents, so the platform treats them carefully: it **adds to them, and never rebuilds them**.

| Navigation              | What the platform does                                                               |
| ----------------------- | ------------------------------------------------------------------------------------ |
| **Top menu bar**        | Adds an entry for the issuer the first time one of its documents is published.       |
| **Issuer landing page** | Adds a heading for a new market and a card for a new document, grouped by market.    |
| **Issuer menu**         | Adds the market and the document, so readers can move between an issuer's documents. |

Once an entry exists, the only thing a later publish changes is **where it points** — so that it follows you to the newest version.

This is deliberate. It means you are free to tailor these shared pages on the portal — reword a card, rename a heading, add an introduction above the cards — and your changes will survive every future publish.

:::info A consequence worth knowing
Because existing entries are left alone, renaming a document, market or issuer in the platform does not rename its card or menu entry on the portal. Update the wording on the portal if you want it to match.
:::

### When two people publish at once

Publications are sent to the portal **one at a time**. If two people publish different documents at the same moment, the second simply waits for the first to finish, and both arrive intact. Neither can overwrite the other's work.

If the same version is published twice in quick succession, the portal ends up showing the later revision.

### Review before going live

Publishing does not change your live portal straight away. Changes arrive in the portal's **staging** area, where they can be previewed, and go live when staging is promoted using the portal's own controls. Until then, your readers continue to see the existing content.

### Checking the result

Sending to the portal happens in the background, shortly after you publish, once the PDF and QuickFIX files are ready. Open the **Document Timeline** to see how it went; each published revision shows its portal status:

| Status         | Meaning                                                                                  |
| -------------- | ---------------------------------------------------------------------------------------- |
| **Pending**    | The revision is waiting to be sent, or is being sent now.                                |
| **Pushed**     | The revision is in the portal's staging area.                                            |
| **Failed**     | The revision could not be sent. Hover over the status to see why.                        |
| **Superseded** | A newer revision of the same version reached the portal first, so this one was not sent. |

The timeline does not refresh by itself — reopen it to see the latest status.

A failed publication is **not retried automatically**, and it does not affect the revision itself: the revision is still published in the platform, with its downloads, as normal. Once the cause has been dealt with, use the **push to portal** button next to the revision to send it again. The button is offered on the latest revision of each version only, since sending an older revision would take the portal's pages backwards.

### FAQs

:::faqs
::faq[Does publishing one document affect my other documents on the portal?]{#faq_publishing_multiple_titles}
No. Each document version has its own pages, images and downloads. The only shared items are the navigation menus and the issuer landing page, and those are only ever added to.
::
::faq[I edited the issuer landing page on the portal. Will publishing undo my changes?]{#faq_publishing_maintaining_editing_landing}
No. Your wording, headings and any extra content are kept. A publish only adds a card for a document that is not listed yet, or updates an existing card's link to the newest version.
::
::faq[I edited one of the document's own pages on the portal. Will that be kept?]{#faq_publishing_editing_pages}
No. A version's pages are rebuilt from the document on every publish. Make the change in the document and publish again.
::
::faq[Can readers still see revision 5.4.1 after I publish 5.4.2?]{#faq_publishing_access_prior_version}
The pages always show the latest revision. The FinSpec, PDF and QuickFIX files for `5.4.1` are kept.
::
::faq[I removed a section from my document. Is it removed from the portal?]{#faq_publishing_removing_nav_sections}
Yes, the next time you publish that version.
::
::faq[I unpublished or deprecated a revision in the platform. Is it removed from the portal?]{#faq_publishing_deprecation}
Not automatically. Content already on the portal is managed using the portal's own controls.
::
::faq[My publication failed. Have I lost anything?]{#faq_publishing_failure}
No. The revision exists in the platform as normal and nothing on the portal was changed. Use the push to portal button on the timeline to try again.
::
:::
