Giter Club home page Giter Club logo

documentation's Introduction

Install

Execute a normal build with gradle:

./gradlew clean build

Upon success open index.html to check your changes.

firefox build/asciidoc/html5/index.html

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

Asciidoctor

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

Simplified installation procedure:

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

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

    • Mind the "ProActive" colors #E87224 and #1c3067

documentation's People

Contributors

fviale avatar cdiop avatar carolinepacheco avatar marcocast avatar imenbizid avatar maelaudren avatar aminelouati avatar shatalovyaroslav avatar sophiesongge avatar chloegugli avatar mbenguig avatar tobwiens avatar andrewssobral avatar alexfalessi avatar paraita avatar mklkun avatar amouhoub avatar mykhailenko avatar dianajlailaty avatar pedrovelho avatar mboussaa avatar lpellegr avatar yinan-liu avatar medou-boushab avatar hiba-alili avatar smirnoveeon avatar nebilbenmabrouk avatar mcompastie avatar luispinedamx avatar oanabiancaschiopu avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.