README.adoc 1.28 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
= Install

Execute a normal build with gradle:

----
./gradlew clean build
----

Upon success open `index.html` to check your changes.

----
12
firefox build/asciidoc/html5/index.html
13
14
15
16
----

Do not forget to follow the naming and capitalization guidelines at the end of this README.

17
= Asciidoctor
18
19
20
21
22
23
24

http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/

http://asciidoctor.org/docs/user-manual/

To write  documentation with live preview see http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/

25
26
27
28
29
30
31
32
33
Simplified installation procedure:

----
gem install bundler
bundle install
mkdir -p build
bundle exec guard
----

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
= How to write ProActive's documentation

* Please read the glossary and use the terms defined in it.
* User interface labels, buttons and actions should be written in _italic_
    ** For instance, "Click on _Submit_ in the web portal"

* Use capitals for ProActive's terms, as defined in the glossary
    ** Workflow, Job, Scheduler

* Use capitals for acronyms: SSH, URL,...

* Lines should 120 characters wide max

* Write code with blocks (----)
+
----
blahblahbcode
----

* If you need to create diagrams: please use https://docs.google.com/a/activeeon.com/document/d/1_krRw8h7i_F1CqfV7H--WHMPPI2nA1wfHsw_x6QIWpc/edit?usp=sharing
54
 ** Mind the "ProActive" colors #E87224 and #1c3067