Getting Started

About 5 min

Getting Started

Now that you have a basic understanding of what pipelines are, let's get started with a simple example. As mentioned in the previous page, we will create a pipeline that is used to create this documentation site. This site is created with vuepressopen in new window, a static site generator for vue.js. It's great for creating documentation sites, and it's pretty straightforward to get started with.

You can find the source code for this site on gitlabopen in new window.

To start off this journey we'll have to take a look at the .nosana-ci.yml file that is used to configure this pipeline. You should be able to find it in the root of the repository.

Yaml is a human readable data serialization format that is commonly used for configuration files. It's easy to read and write, and it's supported by most programming languages. It's the standard for configuring ci/cd pipelines on gitlab, github and other popular code hosting platforms. You can find more information about yaml hereopen in new window.

Let's take a look at the .nosana-ci.yml file for this site: To begin with there are 3 top level definitions that are used to configure the pipeline: nosana, global, and jobs. The nosana section is used to configure the pipeline itself, and the global section is used to configure the environment that the pipeline will run in. The jobs section is used to configure the individual jobs that will be executed in the pipeline.


We'll explore the nosana section first.

# .nosana-ci.yml
    # the name of the nosana pipeline
    description: build and deploy the nosana documentation site
  • description: the name of the pipeline. this is used to identify the pipeline in the nosana network.
Last update: