Articles and collections

Articles are blog or news style posts you publish on your API Portal. You write them under Content, Articles, and you group them into named collections under Content, Collections. Both are entitlement-gated.

How do you add an article?

Go to Content, Articles and choose + Add Article. Apiable creates an article named New Article and opens its editor. Set the title, write the body, then save. New articles are published by default.

1. Open Content, Articles.
2. Choose + Add Article. An article named New Article is created and its editor opens.
3. Edit the title at the top. The slug is generated from the title.
4. Write the body in the editor, and fill in the Description and Tags if you want.
5. Set the visibility toggle, then choose Save changes.

What is in the article editor?

The article editor holds a title, a description, a slug, tags, a featured image, and a rich-text body. Two toggles control publishing and visibility, and a link assigns the article to a collection.

How do you set who can see an article?

Each article has a visibility toggle in its editor. Visible to everyone makes the article public. Logged in users only hides it from visitors who are not signed in. This is separate from the Published toggle.

Published decides whether the article exists on the live portal at all. Visibility then decides whether unauthenticated visitors can see a published article. An article must be Published to appear.

How do you create a collection?

Go to Content, Collections and choose Add another collection. Name it, and it appears in the list. You then assign articles to it from the article editor.

1. Open Content, Collections.
2. Choose Add another collection and enter a name.
3. Open an article under Content, Articles.
4. In the article editor, use the add-to-collection link to assign the article to your collection.
5. Choose Save changes on the article.

How do you rename or delete a collection?

In Content, Collections, open the row menu and choose Edit to rename a collection inline, then choose Update. Choose Delete in the row menu to remove a collection, then confirm.

Where do articles appear on the portal?

Published articles render under the /content path of your portal. An article in a collection appears at /content/collection-name/article-slug. An article with no collection appears at /content/article-slug.

The slug field in the editor previews the full address as you type. The collection name becomes part of the path for articles assigned to a collection.

How do you delete an article?

In the Articles list, open the row menu and choose Delete, then confirm. Apiable checks whether the article is referenced elsewhere first, and a referenced article cannot be deleted.

Troubleshooting

Where to next