/docs-charles

CharlesCD Documentation

Primary LanguageHTMLApache License 2.0Apache-2.0

CharlesCD Documentation

This repository uses hugo server and contains CharlesCD official documentation.

Table of contents

1. About

2. Getting Started

2.1. Requirements

2.2. Installation

2.3. Build

3. Issues

4. Contributing Guide

5. Code of Conduct

6. Community

About

CharlesCD is an open source tool that makes deployments more agile, continuous, and safe, which allows development teams to perform hypothesis validations with a specific group of users, simultaneously.

For more information, check out CharlesCD documentation

Getting started

Requirements

To edit, run and build this project, you will need:

  • Yarn
    • To check the installation, run yarn -v in your terminal.
  • Node
    • To check the installation, run npm -v and node -v in your terminal.
  • Hugo
    • To check the installation, run hugo version in your terminal.

Installation

Run the command below to install the dependencies:

yarn

Build

Run the following command to build this project:

hugo -D --minify

Running

Run the command below:

http-server
  • Now, check if the Web Server is available at http://localhost:8080.

You can see the folder generated by Hugo into ./dist path.

Running the website locally

Once you've cloned this repo, from the root folder, run the command:

hugo server

Issues

To open or track an issue for this project, in order to better coordinate your discussions, we recommend that you use the Issues tab in the main CharlesCD repository.

Contributing Guide

Check out CharlesCD's documentation Contributing Guide to contribute to our documentation.

Code of Conduct

Please read the Code of Conduct.

Community

Do you have any questions or ideas? Let's chat in our Zup Open Source Forum or GitHub Issues.

Keep evolving 🚀