ariatosca-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From arthurbere...@apache.org
Subject incubator-ariatosca-website git commit: Updating Getting Started page
Date Tue, 04 Jul 2017 13:37:03 GMT
Repository: incubator-ariatosca-website
Updated Branches:
  refs/heads/master 0b2bd34d0 -> b38a93ded


Updating Getting Started page


Project: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/commit/b38a93de
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/tree/b38a93de
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/diff/b38a93de

Branch: refs/heads/master
Commit: b38a93deddf527ee09652511fb04c70646d4dc1b
Parents: 0b2bd34
Author: arthur <rtpro1@gmail.com>
Authored: Tue Jul 4 16:36:41 2017 +0300
Committer: arthur <rtpro1@gmail.com>
Committed: Tue Jul 4 16:36:41 2017 +0300

----------------------------------------------------------------------
 _site/atom.xml                   |  2 +-
 _site/build_site.sh              | 11 ++++-
 _site/getting-started/index.html | 91 +++++++++++++++++++++++++++--------
 gettingstarted.md                | 69 +++++++++++++++++---------
 4 files changed, 126 insertions(+), 47 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/b38a93de/_site/atom.xml
----------------------------------------------------------------------
diff --git a/_site/atom.xml b/_site/atom.xml
index fab2994..392f04b 100644
--- a/_site/atom.xml
+++ b/_site/atom.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom"><generator
uri="http://jekyllrb.com" version="3.1.6">Jekyll</generator><link href="/atom.xml"
rel="self" type="application/atom+xml" /><link href="/" rel="alternate" type="text/html"
/><updated>2017-06-22T16:52:46+03:00</updated><id>/</id><title>Apache
ARIA TOSCA</title><subtitle>ARIA is an agile reference implementation of automation
based on OASIS TOSCA Specification. It is a framework for implementing orchestration software
and a command line tool to execute TOSCA based application blueprints.</subtitle></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom"><generator
uri="http://jekyllrb.com" version="3.1.6">Jekyll</generator><link href="/atom.xml"
rel="self" type="application/atom+xml" /><link href="/" rel="alternate" type="text/html"
/><updated>2017-07-04T16:35:31+03:00</updated><id>/</id><title>Apache
ARIA TOSCA</title><subtitle>ARIA is an agile reference implementation of automation
based on OASIS TOSCA Specification. It is a framework for implementing orchestration software
and a command line tool to execute TOSCA based application blueprints.</subtitle></feed>

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/b38a93de/_site/build_site.sh
----------------------------------------------------------------------
diff --git a/_site/build_site.sh b/_site/build_site.sh
index 70f2e86..ce449f0 100755
--- a/_site/build_site.sh
+++ b/_site/build_site.sh
@@ -1,9 +1,16 @@
 #!/bin/bash
-
 WORKDIR=/tmp/incubator-ariatosca-site
 rm -rf $WORKDIR
 mkdir -p $WORKDIR
-bundle exec jekyll build --destination $WORKDIR $WORKDIR
+export RUBY_PATH=~/shared/.rvm
+export GEM_HOME=${RUBY_PATH}/gems
+curl -sSL https://get.rvm.io | bash -s -- --path ${RUBY_PATH}
+mkdir -p ${GEM_HOME}/gems
+gem install  --install-dir ${GEM_HOME} bundler
+export PATH=${GEM_HOME}/bin:$PATH
+bundle install --path ${GEM_HOME}
+bundle
+bundle exec jekyll build --destination $WORKDIR
 git checkout asf-site
 git clean -f -d
 git pull origin asf-site

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/b38a93de/_site/getting-started/index.html
----------------------------------------------------------------------
diff --git a/_site/getting-started/index.html b/_site/getting-started/index.html
index 155490b..1c4e4ce 100644
--- a/_site/getting-started/index.html
+++ b/_site/getting-started/index.html
@@ -127,51 +127,100 @@
 		        <div class="row">
 								<h2 id="installation">Installation</h2>
 
-<p>ARIA is <a href="https://pypi.python.org/pypi/ariatosca">available on PyPI</a>.</p>
+<p>ARIA is <a href="https://pypi.python.org/pypi/apache-ariatosca">available
on PyPI</a>.</p>
 
-<p>To install ARIA directly from PyPI (using a <code class="highlighter-rouge">wheel</code>),
use:</p>
+<p>ARIA requires Python 2.6/2.7. Python 3 is currently not supported.</p>
 
-<div class="highlighter-rouge"><pre class="highlight"><code># pip install
aria
+<p>To install ARIA directly from PyPI (using a <code class="highlighter-rouge">wheel</code>),
use::</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>pip install
--upgrade pip setuptools
+pip install apache-ariatosca
 </code></pre>
 </div>
 
 <p>To install ARIA from source, download the source tarball from
-<a href="https://pypi.python.org/pypi/ariatosca">PyPI</a>, extract it, and then
when inside the extracted
-directory, use:</p>
+<a href="https://pypi.python.org/pypi/apache-ariatosca">PyPI</a>, extract and
<code class="highlighter-rouge">cd</code> into the extract dir, and run::</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>pip install
--upgrade pip setuptools
+pip install .
+</code></pre>
+</div>
 
-<div class="highlighter-rouge"><pre class="highlight"><code># pip install
.
+<table>
+  <tbody>
+    <tr>
+      <td>The source package comes along with relevant examples, documentation, <code
class="highlighter-rouge">requirements.txt</code> (for installing specifically the
frozen dependencies’ versions with which ARIA was tested) and more.</td>
+    </tr>
+    <tr>
+      <td> </td>
+    </tr>
+    <tr>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>ARIA has additional optional dependencies. These are required for running
operations over SSH.</td>
+    </tr>
+    <tr>
+      <td>Below are instructions on how to install these dependencies, including required
system dependencies per OS.</td>
+    </tr>
+    <tr>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>Note: These dependencies may have varying licenses which may not be compatible
with Apache license 2.0.</td>
+    </tr>
+    <tr>
+      <td> </td>
+    </tr>
+  </tbody>
+</table>
+
+<p><strong>Ubuntu/Debian</strong> (tested on Ubuntu14.04, Ubuntu16.04)::</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>apt-get install
-y python-dev gcc libffi-dev libssl-dev
+pip install aria[ssh]
 </code></pre>
 </div>
 
-<p>The source package comes along with relevant examples and documentation. Additionally,
<code class="highlighter-rouge">requirements.txt</code> is included for
-installing the depending packages with which ARIA was tested.</p>
+<p><strong>Centos</strong> (tested on Centos6.6, Centos7)::</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>yum install
-y python-devel gcc libffi-devel openssl-devel
+pip install aria[ssh]
+</code></pre>
+</div>
 
-<p>Note that for the <code class="highlighter-rouge">pip install</code>
commands mentioned above, you must use a privileged user, or use
-virtualenv.</p>
+<p><strong>Archlinux</strong>::</p>
 
-<p>ARIA itself is in a <code class="highlighter-rouge">wheel</code> format
compatible with all platforms. Some dependencies, however,
-might require compilation (based on a given platform), and therefore possibly some system
-dependencies are required as well.</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>pacman -Syu
--noconfirm python2 gcc libffi openssl
+pip2 install aria[ssh]
+</code></pre>
+</div>
 
-<p>On Ubuntu or other Debian-based systems::</p>
+<p><strong>Windows</strong> (tested on Win10)::</p>
 
-<div class="highlighter-rouge"><pre class="highlight"><code>sudo apt install
python-setuptools python-dev build-essential libssl-dev libffi-dev
+<div class="highlighter-rouge"><pre class="highlight"><code># no additional
system requirements are needed
+pip install aria[ssh]
 </code></pre>
 </div>
 
-<p>On Archlinux::</p>
+<p><strong>MacOS</strong>::</p>
 
-<div class="highlighter-rouge"><pre class="highlight"><code>sudo pacman
-S python-setuptools
+<div class="highlighter-rouge"><pre class="highlight"><code># TODO
 </code></pre>
 </div>
 
-<p>ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.</p>
+<p>To install <code class="highlighter-rouge">pip</code>, either use your
distro’s package management system, or run::</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>wget http://bootstrap.pypa.io/get-pip.py
+python get-pip.py
+</code></pre>
+</div>
 
-<h2 id="getting-started-with-aria-tosca">Getting Started with ARIA TOSCA</h2>
+<h2 id="getting-started">Getting Started</h2>
 
 <p>This section will describe how to run a simple “Hello World” example.</p>
 
-<p>First, provide ARIA with the ARIA “hello world” service-template and name it
(e.g.
+<p>First, provide ARIA with the ARIA “hello world”(can be download <a href="https://github.com/apache/incubator-ariatosca/tree/master/examples/hello-world">here</a>)
service-template and name it (e.g.
 <code class="highlighter-rouge">my-service-template</code>)::</p>
 
 <div class="highlighter-rouge"><pre class="highlight"><code>aria service-templates
store examples/hello-world/helloworld.yaml my-service-template
@@ -204,7 +253,7 @@ aria service-templates delete my-service-template
 <h2 id="license">License</h2>
 
 <p>ARIA is licensed under the
-<a href="https://github.com/apache/incubator-ariatosca/blob/master/LICENSE">Apache
License 2.0</a></p>
+<a href="https://github.com/apache/incubator-ariatosca/blob/master/LICENSE">Apache
License 2.0</a>.</p>
 
 		        </div>
 		      </div>

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/b38a93de/gettingstarted.md
----------------------------------------------------------------------
diff --git a/gettingstarted.md b/gettingstarted.md
index 4f54e38..2838fb5 100644
--- a/gettingstarted.md
+++ b/gettingstarted.md
@@ -8,45 +8,69 @@ share: false
 Installation
 ------------
 
-ARIA is [available on PyPI](https://pypi.python.org/pypi/ariatosca).
+ARIA is [available on PyPI](https://pypi.python.org/pypi/apache-ariatosca).
 
-To install ARIA directly from PyPI (using a ``wheel``), use:
+ARIA requires Python 2.6/2.7. Python 3 is currently not supported.
 
-    # pip install aria
+To install ARIA directly from PyPI (using a ``wheel``), use::
+
+    pip install --upgrade pip setuptools
+    pip install apache-ariatosca
 
 To install ARIA from source, download the source tarball from
-[PyPI](https://pypi.python.org/pypi/ariatosca), extract it, and then when inside the extracted
-directory, use:
+[PyPI](https://pypi.python.org/pypi/apache-ariatosca), extract and ``cd`` into the extract
dir, and run::
+
+    pip install --upgrade pip setuptools
+    pip install .
+
+| The source package comes along with relevant examples, documentation, ``requirements.txt``
(for installing specifically the frozen dependencies' versions with which ARIA was tested)
and more.
+|
+|
+| ARIA has additional optional dependencies. These are required for running operations over
SSH.
+| Below are instructions on how to install these dependencies, including required system
dependencies per OS.
+|
+| Note: These dependencies may have varying licenses which may not be compatible with Apache
license 2.0.
+|
+
+**Ubuntu/Debian** (tested on Ubuntu14.04, Ubuntu16.04)::
+
+    apt-get install -y python-dev gcc libffi-dev libssl-dev
+    pip install aria[ssh]
 
-    # pip install .
+**Centos** (tested on Centos6.6, Centos7)::
 
-The source package comes along with relevant examples and documentation. Additionally, ``requirements.txt``
is included for
-installing the depending packages with which ARIA was tested.
+    yum install -y python-devel gcc libffi-devel openssl-devel
+    pip install aria[ssh]
 
-Note that for the ``pip install`` commands mentioned above, you must use a privileged user,
or use
-virtualenv.
+**Archlinux**::
 
-ARIA itself is in a ``wheel`` format compatible with all platforms. Some dependencies, however,
-might require compilation (based on a given platform), and therefore possibly some system
-dependencies are required as well.
+    pacman -Syu --noconfirm python2 gcc libffi openssl
+    pip2 install aria[ssh]
 
-On Ubuntu or other Debian-based systems::
+**Windows** (tested on Win10)::
 
-    sudo apt install python-setuptools python-dev build-essential libssl-dev libffi-dev
+    # no additional system requirements are needed
+    pip install aria[ssh]
 
-On Archlinux::
+**MacOS**::
 
-    sudo pacman -S python-setuptools
+    # TODO
 
-ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.
 
 
-Getting Started with ARIA TOSCA
---------------------------------
+To install ``pip``, either use your distro's package management system, or run::
+
+    wget http://bootstrap.pypa.io/get-pip.py
+    python get-pip.py
+
+
+
+Getting Started
+---------------
 
 This section will describe how to run a simple "Hello World" example.
 
-First, provide ARIA with the ARIA "hello world" service-template and name it (e.g.
+First, provide ARIA with the ARIA "hello world"(can be download [here](https://github.com/apache/incubator-ariatosca/tree/master/examples/hello-world))
service-template and name it (e.g.
 ``my-service-template``)::
 
     aria service-templates store examples/hello-world/helloworld.yaml my-service-template
@@ -69,9 +93,8 @@ To uninstall and clean your environment, follow these steps::
     aria service-templates delete my-service-template
 
 
-
 License
 -------
 
 ARIA is licensed under the
-[Apache License 2.0](https://github.com/apache/incubator-ariatosca/blob/master/LICENSE)
+[Apache License 2.0](https://github.com/apache/incubator-ariatosca/blob/master/LICENSE).


Mime
View raw message