Corilla User Guide
Introducing Corilla

Welcome to corilla

Welcome to the Corilla documentation! This documentation is a quick introduction to the workflow and features of Corilla. Let's get you writing and publishing documentation today.

Understanding the Corilla workflow

Understanding the Corilla workflow

Corilla was originally built by a group of technical writers to solve the problem of creating collaborative documentation for software teams.

The team felt that the existing technical solutions were getting in the way of what mattered most - just getting on with the job of writing and wrangling content. It was time to design a solution that put the content team first.

Software documentation isn't where we've stopped. These days you can use Corilla for everything from staging your company's marketing content through to collaborating with academics across multiple countries. Or even planets - hi Elon 👋.

Introducing topics

Introducing topics

Topics are the basic content types in Corilla. We've built them to be very flexible. You can use a topic like a fully-featured document or even just as a bunch of atomic content chunks to combine and publish in a collection.

If you are writing documentation you will benefit from writing a topic to document a specific user task. In this way Corilla is inspired by an interpretation of both the topic-based authoring and DITA models of technical writing.

Corilla looks at topics as a logical container that best fits the content needs of the modern web. They are the lego bricks of our information age.

Examples of specific topics:

  • Deploy a server with Awesome Application Server 1.0
  • Quickstart guide to working with Awesome Application Server 1.0
  • Manage remote teams with the admin console
  • Import mailing lists with Monkey Product
  • Ten reasons to tell everyone to use Corilla
Create and edit topics

Create and edit topics in Corilla

Create topics

Create a new topic by clicking on the New Topic button. Enter a descriptive title.

We recommend thinking of the context of your title with your other topics in your content suite. Also be mindful of the impact of your content's discoverability online.

But don't worry, you can change a title anytime in the topic view mode.

Writing and editing topics

The Corilla editor is a blazing fast implementation of the Markdown syntax.

Markdown is a lightweight markup language created by John Gruber and Aaron Schwartz in 2004. We've created a cheat sheet for new users to learn this easy syntax.

Titles

In our beta version, topic titles are changed for internal views by clicking on the topic title name directly in the top left of the editing pane. To change the published title, simply change the

Introducing collections

Introducing collections

A collection in Corilla is a dynamic container for you to sort and order the topics you want to publish or export. this container concept allows for the maximum reuse of existing content - without the need to copy and paste or duplicate specific information.

Collections are a very versatile way to group and publish content either on-demand or as part of a fixed resource.

Here are some things you can use a collection for:

  • Your company's public-facing documentation published to the Corilla knowledge base.
  • A project team's internal documentation published to Corilla's private docs portal.
  • Compiling a new employee onboarding guide with all the generic company information, but only the role-specific information related to their job. And then sending them their own unique published link.

What makes collections so great is that they allow you to access and view your saved documents in specific context. There's no need to copy and paste from inside of documents anymore. Just group the documents you want to combine and ship it. All in a few easy clicks with a beautiful and intuitive interface.

Create and manage collections

Create and manage collections

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Publishing collections with Corilla

Publishing collections with Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

About refresh times on the knowledge base

About delays to published updates in the knowledge base

Some updates to the knowledge base may take up to five minutes to refresh. This is due to the manner in which Corilla uses various features of Amazon Web Services to cache your content and improve performance for your documentation readers.

In more specific terms, Corilla is using Amazon CloudFront as a content delivery network (CDN). Content delivery networks provide a globally-distributed network of proxy servers which cache content. This allows content such as web videos or other bulky media to be stored more locally to users.

What makes this CDN methodology so fast for users can make for some small delays in publish content to be refreshed through the CDN. This is an area that we are working on and tracking in our public road map.

About tags and filters in Corilla

About tags and filters in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Manage media files in Corilla

Manage media files in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

About team management in Corilla

About team management in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Switching to Corilla

Switching to Corilla

The best thing about Corilla is the ease of getting started. You just need to start writing and you're good to go.

Automated importing is on our transparent public roadmap at the moment. Which has a small but important benefit for you in the meantime. For all new users migrating to Corilla, we'll actually help you migrate your content.

If you're migrating into Corilla or would like a trial example of your content hosted and published with Corilla, just drop us a line and we'll get started.