An open API service indexing awesome lists of open source software.

https://github.com/atata-framework/atata.io

Atata Framework documentation
https://github.com/atata-framework/atata.io

atata docs

Last synced: 2 months ago
JSON representation

Atata Framework documentation

Awesome Lists containing this project

README

          

# [Atata Framework documentation](https://atata.io)

[![Docs](https://img.shields.io/badge/docs-Atata_Framework-orange.svg)](https://atata.io)
[![Twitter](https://img.shields.io/badge/follow-@AtataFramework-blue.svg)](https://twitter.com/AtataFramework)
[![Slack](https://img.shields.io/badge/join-Slack-green.svg?colorB=4EB898)](https://join.slack.com/t/atata-framework/shared_invite/zt-5j3lyln7-WD1ZtMDzXBhPm0yXLDBzbA)

Documentation for the [Atata Framework](https://github.com/atata-framework/atata).

## Setup documentation

### Jekyll

Jekyll is used as an engine for documentation generation.
Therefore, Ruby and Jekyll should be installed.
To configure Jekyll for Atata documentation locally follow [Jekyll on Windows](https://jekyllrb.com/docs/installation/windows/) installation instructions.
[RubyInstaller](https://rubyinstaller.org/downloads/) can be used to install Ruby.

### Ruby gems

Install Ruby gems using command shell:

```
gem install jekyll bundler
```

### Build

In order to build the documentation, execute the command: `bundle exec jekyll build` or run `build.bat`.

## License

Atata is an open-source software, licensed under the Apache License 2.0.
See [LICENSE](LICENSE) for details.