karaf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbono...@apache.org
Subject [karaf-site] branch trunk updated: WIP: add get-started page
Date Mon, 11 Feb 2019 10:02:39 GMT
This is an automated email from the ASF dual-hosted git repository.

jbonofre pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/karaf-site.git


The following commit(s) were added to refs/heads/trunk by this push:
     new affdf60  WIP: add get-started page
     new 6403c6e  Merge pull request #35 from fpapon/GET-STARTED
affdf60 is described below

commit affdf605d636413b0b7dd92e421fb5a004190402
Author: Francois Papon <francois.papon@openobject.fr>
AuthorDate: Sun Jan 27 16:04:22 2019 +0400

    WIP: add get-started page
---
 src/main/webapp/archives.html      |   3 +
 src/main/webapp/community.html     |   3 +
 src/main/webapp/documentation.html |   3 +
 src/main/webapp/download.html      |   3 +
 src/main/webapp/get-started.html   | 317 +++++++++++++++++++++++++++++++++++++
 src/main/webapp/index.html         |   3 +
 src/main/webapp/news.html          |   3 +
 src/main/webapp/privacy.html       |   3 +
 src/main/webapp/projects.html      |   3 +
 src/main/webapp/stories.html       |   3 +
 10 files changed, 344 insertions(+)

diff --git a/src/main/webapp/archives.html b/src/main/webapp/archives.html
index 3844f00..b0e9140 100644
--- a/src/main/webapp/archives.html
+++ b/src/main/webapp/archives.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News</span></a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item active">
diff --git a/src/main/webapp/community.html b/src/main/webapp/community.html
index 23b1e4e..5853b7d 100644
--- a/src/main/webapp/community.html
+++ b/src/main/webapp/community.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News</a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item">
diff --git a/src/main/webapp/documentation.html b/src/main/webapp/documentation.html
index 602d8bc..2f57464 100644
--- a/src/main/webapp/documentation.html
+++ b/src/main/webapp/documentation.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News</a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item">
diff --git a/src/main/webapp/download.html b/src/main/webapp/download.html
index 6654cfe..de73bb5 100644
--- a/src/main/webapp/download.html
+++ b/src/main/webapp/download.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News</span></a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item active">
diff --git a/src/main/webapp/get-started.html b/src/main/webapp/get-started.html
new file mode 100644
index 0000000..f5c7afa
--- /dev/null
+++ b/src/main/webapp/get-started.html
@@ -0,0 +1,317 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="description" content="">
+    <meta name="author" content="">
+    <link rel="icon" href="images/favicon.ico">
+
+    <title>Apache Karaf - The enterprise class platform</title>
+
+    <!-- Bootstrap core CSS -->
+    <link href="css/bootstrap.min.css" rel="stylesheet">
+    <!-- Fontawesome CSS CDN -->
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css"
integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
+    <!-- Custom styles for this template -->
+    <link href="css/karaf.css" rel="stylesheet">
+  </head>
+  <body>
+
+    <header>
+      <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark">
+        <div class="container">
+          <a class="navbar-brand" href="index.html"><img src="images/karaf-logo-new.png"/></a>
+          <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse"
aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+          </button>
+          <div class="collapse navbar-collapse justify-content-end" id="navbarCollapse">
+            <div>
+              <ul class="navbar-nav mr-auto align-items-center text-uppercase">
+                <li class="nav-item">
+                  <a class="nav-link" href="index.html">Home</a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="news.html">News</a>
+                </li>
+                <li class="nav-item active">
+                  <a class="nav-link" href="get-started.html">Get started <span
class="sr-only">(current)</span></a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="projects.html">Projects</a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="download.html">Download</a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="documentation.html">Documentation</a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="community.html">Community</a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="stories.html">Stories</a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link disabled" href="https://www.apache.org"><img
src="images/apache-feather-tm-new.png"/></a>
+                </li>
+              </ul>
+            <div>
+          </div>
+        </div>
+      </nav>
+    </header>
+
+    <div class="container pt-5 pb-3">
+      <div class="jumbotron p-3 p-md-5 text-white bg-primary">
+        <div class="col-md-12 px-0">
+          <h1 class="display-4 font-italic">Get started with Apache Karaf is very easy!</h1>
+        </div>
+      </div>
+    </div>
+
+    <main role="main">
+
+      <div class="container">
+
+        <!-- Easy to install -->
+        <div class="row mb-2 mt-3">
+            <div class="col">
+              <h2 class="pb-3 mb-4 font-italic border-bottom"><i class="fas fa-box"></i>
Easy to install</h2>
+              <p>The only prerequisite to start with Karaf is a Java SE 8 / 9 / 10
/ 11 environment to run.
+                Refer to <a target="_blank" href="https://www.oracle.com/technetwork/java/javase">https://www.oracle.com/technetwork/java/javase</a>
for details on how to download and install Java SE 1.8 or greater.</p>
+            </div>
+        </div>
+
+        <div class="row mb-2 mt-2">
+            <div class="col">
+              <h4 class="pb-3 mb-1">Download and extract</h4>
+              <ol>
+                <li>Open a Web browser and access the following URL: <a target="_blank"
href="https://karaf.apache.org/download.html">
+                  https://karaf.apache.org/download.html</a>.</li>
+                <li>Download the binary distribution of Karaf Runtime that matches
your system (zip for windows, tar.gz for unixes).</li>
+                <li>Extract the archive to a new folder on your hard drive. For example
in <code>/opt/karaf</code>, from now on this directory will be
+                  referenced as <code>$KARAF_HOME</code>.</li>
+              </ol>
+            </div>
+        </div>
+
+        <div class="row mb-5 mt-2">
+          <div class="col">
+            <h4 class="pb-3 mb-1">Start and connect</h4>
+            <ol>
+              <li>Open a command line console and change the directory to <code>$KARAF_HOME</code>.</li>
+              <li>To start the server, run the following command on Unix:
+                <pre class="alert alert-primary"><code>$KARAF_HOME/bin/karaf</code></pre>
+                Respectively on Windows:
+                <pre class="alert alert-primary"><code>$KARAF_HOME\bin\karaf.bat</code></pre>
+              </li>
+              <li>You are now connected to the Karaf shell!</li>
+            </ol>
+
+            <p>
+              <pre class="alert alert-primary"><code>
+        __ __                  ____
+       / //_/____ __________ _/ __/
+      / ,<  / __ `/ ___/ __ `/ /_
+     / /| |/ /_/ / /  / /_/ / __/
+    /_/ |_|\__,_/_/   \__,_/_/
+
+  Apache Karaf (4.2.0)
+
+Hit '<tab>' for a list of available commands
+and '[cmd] --help' for help on a specific command.
+Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown Karaf.
+
+karaf@root()>
+              </code></pre>
+            </p>
+            <p><i class="fa fa-info-circle"></i> If you want to launch
your Karaf instance in background, run on Unix:
+              <pre class="alert alert-primary"><code>$KARAF_HOME/bin/start</code></pre>
+            </p>
+            <p>Respectively on Windows:
+              <pre class="alert alert-primary"><code>$KARAF_HOME\bin\start.bat</code></pre>
+            </p>
+          </div>
+        </div>
+
+        <!-- Easy to manage -->
+        <div class="row mb-2 mt-3">
+          <div class="col">
+            <h2 class="pb-3 mb-4 font-italic border-bottom"><i class="fas fa-laptop"></i>
Easy to manage</h2>
+            <p>You can manage your Karaf instance with the shell console to a local
instance or to a remote instance using the ssh client.</p>
+          </div>
+        </div>
+
+        <div class="row mb-2 mt-2">
+          <div class="col">
+            <h4 class="pb-3 mb-1">Connect to the shell console</h4>
+            <ol>
+              <li>Open a command line console and change the directory to <code>$KARAF_HOME</code>.</li>
+              <li>To connect to the local instance, run in Unix:
+                <pre class="alert alert-primary"><code>$KARAF_HOME/bin/client</code></pre>
+                Respectively on Windows:
+                <pre class="alert alert-primary"><code>$KARAF_HOME\bin\client.bat</code></pre>
+                </li>
+            </ol>
+            <p><i class="fa fa-info-circle"></i> To connect to a remote
instance, run:</p>
+            <pre class="alert alert-primary"><code>$KARAF_HOME/bin/client -a
"IP" -p "PORT"</code></pre>
+            <p>You can also use any regular <code>ssh</code> client.</p>
+          </div>
+        </div>
+
+        <div class="row mb-2 mt-2">
+          <div class="col">
+            <h4 class="pb-3 mb-1">Shell console basics</h4>
+            <p>
+              You can now run your first command. Simply type the <code>tab</code>
key in the console.
+            </p>
+            <pre class="alert alert-primary"><code>
+karaf@root()>
+karaf: do you wish to see to see all 356 possibilities (219 lines)?
+karaf@root()> Display all 294 possibilities? (y or n)
+...
+shell:logout                        shell:more                          shell:new       
                   shell:printf                        shell:sleep                       
 shell:sort                          shell:source
+shell:stack-traces-print            shell:tac                           shell:tail      
                   shell:threads                       shell:watch                       
 shell:wc                            shell:while
+shutdown                            sleep                               sort            
                   source                              ssh                               
 ssh                                 ssh-host-change
+ssh-port-change                     ssh:ssh                             stack-traces-print
                 start                               start-level                         status
                             stop
+su                                  sudo                                system          
                   system:framework                    system:name                       
 system:property                     system:shutdown
+system:start-level                  system:version                      tac             
                   tail                                threads                           
 tree-show                           uninstall
+update                              user-add                            user-delete     
                   user-list                           version                           
 version-list                        wait
+watch                               wc                                  while
+            </code></pre>
+            <p>You can then grab more specific help for a given command using the <code>--help</code>
option for this command:</p>
+            <pre class="alert alert-primary"><code>
+karaf@root()> bundle:list --help
+DESCRIPTION
+        bundle:list
+
+        Lists all installed bundles.
+
+SYNTAX
+        bundle:list [options] [ids]
+
+ARGUMENTS
+        ids
+                The list of bundle (identified by IDs or name or name/version) separated
by whitespaces
+
+OPTIONS
+        -name, -n
+                Show bundle name
+        -u
+                Shows the update locations
+        -r
+                Shows the bundle revisions
+        --no-ellipsis
+
+        -l
+                Show the locations
+        -s
+                Shows the symbolic name
+        --context, -c
+                Use the given bundle context
+                (defaults to 0)
+        --help
+                Display this help message
+        -t
+                Specifies the bundle threshold; bundles with a start-level less than this
value will not get printed out.
+        --no-format
+                Disable table rendered output
+            </code></pre>
+            <p>
+              Note that the console supports tab completion so if you start typing a command
it will show all possible completions and also auto
+              complete if there is only one completion.
+            </p>
+          </div>
+        </div>
+
+        <div class="row mb-2 mt-2">
+          <div class="col">
+            <h4 class="pb-3 mb-1">Stop</h4>
+            You have multiple options for shuting down your Karaf instance:
+            <ul>
+              <li>For a background running instance, run the command on Unix:
+                <pre class="alert alert-primary"><code>$KARAF_HOME/bin/stop</code></pre>
+                Respectively on Windows:
+                <pre class="alert alert-primary"><code>$KARAF_HOME\bin\stop.bat</code></pre>
+              </li>
+              <li>To stop Karaf from the console, enter <code>Ctrl+D</code>.</li>
+              <li>Alternatively, you can also run the following command:
+                <pre class="alert alert-primary"><code>
+karaf@root()> feature:install system
+karaf@root()> system:shutdown
+Confirm: halt instance root (yes/no): yes
+karaf@root()>
+                </code></pre>
+              </li>
+            </ul>
+            <p><i class="fa fa-info-circle"></i> Halt is also an alias
for <code>system:shutdown</code>
+              <pre class="alert alert-primary"><code>karaf@root()> halt</code></pre>
+            </p>
+          </div>
+        </div>
+
+        <!-- Easy to develop -->
+        <div class="row mb-2 mt-3">
+          <div class="col">
+            <h2 class="pb-3 mb-4 font-italic border-bottom"><i class="fas fa-code"></i>
Easy to develop</h2>
+            <p>You are now ready to develop your first application!</p>
+            <p>A list of examples are packaged in the distribution (<code>$KARAF_HOME/examples</code>).
+              You can have an overview of this examples in the documentation page <a href="documentation.html">here</a>.
+            </p>
+          </div>
+        </div>
+
+        <div class="row mb-2 mt-2">
+          <div class="col">
+            <h4 class="pb-3 mb-1">Tips for developers</h4>
+            <p>You can activate debug mode by adding the parameter <code>debug</code>
to the command line:
+                <pre class="alert alert-primary"><code>$KARAF_HOME/bin/karaf
debug</code></pre></li>
+              Then you can connect to the instance from remote with your IDE on the port
<code>5005</code>.
+            </p>
+            <p>After building your bundle with maven, you can install it from the console:</p>
+            <pre class="alert alert-primary"><code>karaf@root()> bundle:install
-s mvn:groupId/artifactId/1.0.0-SNAPSHOT</code></pre>
+            <p>The <code>bundle:watch</code> command enables watching the
local Maven repository for updates on bundles. If the bundle file changes on the Maven repository,
+              Apache Karaf will automatically update the bundle.</p>
+            <pre class="alert alert-primary"><code>karaf@root()> bundle:watch
*</code></pre>
+            <p>From now, your bundle will automatically update by Karaf after each
local build.</p>
+          </div>
+        </div>
+
+        <!-- Want more -->
+        <div class="row mb-2 mt-3">
+          <div class="col">
+            <h2 class="pb-3 mb-4 font-italic border-bottom"><i class="far fa-comments"></i>
What? You thought it was difficult to develop with Karaf?</h2>
+            <p>You want more! Ok, let's going deeper with the manual <a href="manual/latest"
target="_blank">here</a>.</p>
+          </div>
+        </div>
+
+      </div>
+    </main>
+
+    <!-- FOOTER -->
+    <footer class="container-fluid bg-dark pt-5 pb-3 text-white text-center ">
+      <div class="mx-auto pb-5">
+        <h2>Ready, efficient, and productive with Karaf in a minute !</h2>
+        <p class="pt-2"><a class="btn btn-primary" href="documentation.html" role="button">Read
Documentation &raquo;</a></p>
+      </div>
+      <p class="float-right"><a href="#">Back to top</a></p>
+      <p>&copy; 2018-2019 <a href="https://www.apache.org">Apache Software
Foundation</a> -
+        <a href="privacy.html">Privacy Policy</a> -
+        <a target="_blank" href="https://www.apache.org/events/current-event.html" title="Apache
Events">Apache Events</a> -
+        <a target="_blank" href="https://www.apache.org/licenses/" title="Licenses">Licenses</a>
-
+        <a target="_blank" href="https://www.apache.org/security/" title="Security">Security</a>
-
+        <a target="_blank" href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
-
+        <a target="_blank" href="https://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a><br/>
+      Apache Karaf, Karaf, Apache, the Apache feather logo, and the Apache Karaf project
logo are trademarks of The Apache Software Foundation.</p>
+    </footer>
+
+    <!-- Bootstrap core JavaScript
+    ================================================== -->
+    <!-- Placed at the end of the document so the pages load faster -->
+    <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
crossorigin="anonymous"></script>
+    <script>window.jQuery || document.write('<script src="assets/js/vendor/jquery-slim.min.js"><\/script>')</script>
+    <script src="assets/js/vendor/popper.min.js"></script>
+    <script src="js/bootstrap.min.js"></script>
+  </body>
+</html>
diff --git a/src/main/webapp/index.html b/src/main/webapp/index.html
index 07c2d98..cb07019 100644
--- a/src/main/webapp/index.html
+++ b/src/main/webapp/index.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News</a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item">
diff --git a/src/main/webapp/news.html b/src/main/webapp/news.html
index 7929ccb..c2a0a20 100644
--- a/src/main/webapp/news.html
+++ b/src/main/webapp/news.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News <span class="sr-only">(current)</span></a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item">
diff --git a/src/main/webapp/privacy.html b/src/main/webapp/privacy.html
index e3094c2..46aafd9 100644
--- a/src/main/webapp/privacy.html
+++ b/src/main/webapp/privacy.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News</a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item">
diff --git a/src/main/webapp/projects.html b/src/main/webapp/projects.html
index 5267388..d189809 100644
--- a/src/main/webapp/projects.html
+++ b/src/main/webapp/projects.html
@@ -34,6 +34,9 @@
                 <li class="nav-item">
                   <a class="nav-link" href="news.html">News</span></a>
                 </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
                 <li class="nav-item active">
                   <a class="nav-link" href="projects.html">Projects <span class="sr-only">(current)</a>
                 </li>
diff --git a/src/main/webapp/stories.html b/src/main/webapp/stories.html
index 37025a3..34c3f7e 100644
--- a/src/main/webapp/stories.html
+++ b/src/main/webapp/stories.html
@@ -35,6 +35,9 @@
                   <a class="nav-link" href="news.html">News</a>
                 </li>
                 <li class="nav-item">
+                  <a class="nav-link" href="get-started.html">Get started</a>
+                </li>
+                <li class="nav-item">
                   <a class="nav-link" href="projects.html">Projects</a>
                 </li>
                 <li class="nav-item">


Mime
View raw message