# ciapp-alpha-docs

**Repository Path**: mirrors_DataDog/ciapp-alpha-docs

## Basic Information

- **Project Name**: ciapp-alpha-docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-26
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CI App alpha docs

[See the docs online](https://datadoghq.dev/ciapp-alpha-docs/).

## How to add documentation

* Clone the repository
```
git clone git@github.com:DataDog/ci-app-alpha-docs.git
```
* Change to the docs folder
```
cd ci-app-alpha-docs/docs
```
* Create your markdown file
```
touch tests/java.md
```
* Add the metadata on top of the file (see [javascript.md](/docs/tests/javascript.md) for an example):
```
---
layout: page
title:  Java Test Instrumentation
permalink: /tests/java
---
```
* Add your instructions to the file.
* Push your code to the `main` branch or create a pull request.

## How to add syntax highlighted code

You can add syntax highlighted code through this tag:
```
{% highlight javascript %}
...
{% endhighlight %}
```

See [javascript.md](/docs/tests/javascript.md) for an example.

## Run docs locally

* Before you can run the docs locally, you need to install `bundler` and `jekyll` using Ruby. ([Full guide](https://jekyllrb.com/docs/installation))
```bash
gem install --user-install bundler jekyll
```

* Change to the docs folder
```bash
cd docs
```

* Execute the `jekyll` bundle
```bash
bundle exec jekyll serve
```