Skip to content

Getting started

Honegumi is a hosted Content-as-a-Service platform accessible at hon.takeoffgo.com.

This getting started guide will take you through the process of registering an account, defining your data model and authoring content. We will use the classic example of creating a project to serve a blog site.

Creating an account

You will need to create an account to use the platform.

This can be done by navigating to the login page.

If you already have an account, enter your email address and password then click the Login button.

If you are new to the platform and do not yet have an account, enter your email address, password and then click the Register button, enter your name and then click the Register button again.

Creating a project

Once you have an account, you'll need to start a project. Projects are a way of organising your content and its structure. You can create as many projects as you need, but note that content, media and models all belong to their project and cannot be shared across projects.

Tip

See the projects topic for more detail on projects.

After you've created an account and logged in, you'll be presented with a screen that lists the projects and accounts you have access to. With a new account, this list will be empty.

Click on the Personal account, then the highlighted New project button to get started.

Enter a name and click ok. You can call projects whatever you like. There are no restrictions on how you name your projects.

Modelling your data

With a project created, you're ready to start building out your content structure.

This starts with constructing models of your data.

Tip

See the models topic for an in-depth look at best practices when it comes to building your content models.

Navigate to the Models section by hovering over the Content item in the top menu, then clicking Models.

Click the New model button and you will be presented with the model definition page.

Model configuration

The name of your model can be whatever you choose in whatever format you like. This is what is displayed to end-users when working with your model.

However, the alias of your model has more restrictions.

It must:

  • start with an upper-case character (A-Z)
  • be at least 3 characters long
  • only contain letters and numbers
  • not contain any punctuation or spacing
  • be unique to your project

Model usage

You must also specify how you intend the model to be used. The models topic explains how you might want to structure your data to best suit your needs. Put simply, though -

  • Entry models are used to create physical entries of content
  • Module models are used to build out modular components within an entry
  • Base models define models that can be incorporated with other entry/module models

For simplicity's sake, select Entry.

Inheritance is also discussed in the models topic and is not required for this example.

Click Save changes to create your model.

Model fields

Once the model is created, you can need to add some fields to it.

After saving the model, you'll be presented with the model detail view, showing no fields in the model.

Click the New field button to create a new field for the model.

Model field configuration

As with the model configuration, the name of your field can be whatever you choose.

The alias of a model field has similar, but slightly different, restrictions to the alias of the model itself.

It must:

  • start with a lower-case character (A-Z)
  • be at least 3 characters long
  • only contain letters and numbers
  • not contain any punctuation or spacing
  • be unique to the model (i.e., a model may not contain two fields with the same alias)

Category can be used to group fields that serve a similar purpose/function.

Order defines the flow in which fields are displayed while authoring content. This must be a whole number greater than or equal to zero.

Type defines what type of input this field takes. The available field types are -

  • text is a plain text field with the option of being multi-line
  • media references items in the project's media library
  • link references another piece of content
  • modules provides a block where any number of content based on models of usage Module can be added

Click the Save changes button to finish creating the field.

Create two fields, Title and Body with aliases title and body respectively, both of type text. Check the Multiline box on the Body field.

Authoring content

Now that you have a project and content model defined, you are ready to start authoring content.

Navigate to the content entries section by hovering over the Content item in the top menu, then clicking Entries.

Click the New entry button to get started.

Enter a Name for your piece of content, such as "My first blog post" and select "Blog post" from the Model dropdown.

After selecting the model type, the fields you configured on your model will be presented ready for content population.

Enter some content, then click the Save changes button.

You have now created your first piece of content, rounding out this guide.