Skip to content

Commit

Permalink
doc: contribute page (#1947)
Browse files Browse the repository at this point in the history
Signed-off-by: Yvonnick Esnault <yvonnick.esnault@corp.ovh.com>
  • Loading branch information
yesnault authored and sguiheux committed Jan 15, 2018
1 parent e564f82 commit 7f9cb77
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2013-2017, OVH SAS.
Copyright (c) 2013-2018, OVH SAS.
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
46 changes: 46 additions & 0 deletions docs/content/contribute/_index.md
@@ -0,0 +1,46 @@
+++
title = "Opensource / Contribute"
weight = 7

+++

## Roadmap

See https://github.com/ovh/cds/blob/master/ROADMAP.md

## Contact us

* Benjamin COENEN - [@BnJ25](https://twitter.com/BnJ25)
* François SAMIN - [@francoissamin](https://twitter.com/francoissamin)
* Steven GUIHEUX - [@sguiheux](https://twitter.com/sguiheux)
* Yvonnick ESNAULT - [@yesnault](https://twitter.com/yesnault)

A remark / question / suggestion, feel free to join us on https://gitter.im/ovh-cds/Lobby

All CDS Contributors: https://github.com/ovh/cds/graphs/contributors

## Found a bug?

Feel free to open an issue on https://github.com/ovh/cds/issues

## Documentation

Documentation https://ovh.github.io/cds is generated with Hugo. Source are under https://github.com/ovh/cds/tree/master/docs/content

### Write / Generate / Test documentation

* Download release Hugo v32.4 https://github.com/gohugoio/hugo/releases/tag/v0.32.4 - put hugo binary in your PATH
* Download CDS Binaries: cdsctl, engine, worker from https://github.com/ovh/cds/releases/latest
* Clone CDS repository: git clone https://github.com/ovh/cds.git inside ${CDS_SOURCES}
* Generate documentation with Hugo

```bash
cd ${CDS_SOURCES}/docs/content/cli
rm -rf cdsctl engine worker;
cdsctl doc # generate cdsctl documentation inside ${CDS_SOURCES}/docs/content/cli/cdsctl
engine doc # generate engine documentation
worker doc # generate worker documentation
cd ${CDS_SOURCES}/docs
hugo server
```
* go to http://localhost:1313/cds/

0 comments on commit 7f9cb77

Please sign in to comment.