You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@openwhisk.apache.org by GitBox <gi...@apache.org> on 2018/09/07 17:27:11 UTC
[GitHub] pritidesai closed pull request #332: Add anchors to home page;
fix documentation index
pritidesai closed pull request #332: Add anchors to home page; fix documentation index
URL: https://github.com/apache/incubator-openwhisk-website/pull/332
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/_layouts/documentation.html b/_layouts/documentation.html
index 45e4404..236a084 100644
--- a/_layouts/documentation.html
+++ b/_layouts/documentation.html
@@ -16,6 +16,7 @@
<!-- Operators -->
<li class="collapsible-toggle"><a href="#operators">Operators</a></li>
<ul class="collapse-content">
+ <li><a href="#openwhisk_architecture">OpenWhisk Architecture</a></li>
<li class="collapsible-toggle"><a href="#openwhisk_deployment">OpenWhisk Deployment</a></li>
<ul class="collapse-content">
<li><a href="#deploy_docker_compose">Docker Compose</a></li>
@@ -35,9 +36,12 @@
<li><a href="#pre-requisites">Pre-requisites</a></li>
<li class="collapsible-toggle"><a href="#using-openwhisk">Using OpenWhisk</a></li>
<ul class="collapse-content">
- <li><a href="#wsk-cli-install">Installing wsk CLI</a></li>
- <li><a href="#wsk-cli">Configuring wsk CLI</a></li>
- <li><a href="#wskdeploy">Deployment Tool - wskdeploy</a></li>
+ <li class="collapsible-toggle"><a href="#wsk-cli">OpenWhisk CLI (wsk)</a></li>
+ <ul class="collapse-content">
+ <li><a href="#wsk-cli-install">Installing</a></li>
+ <li><a href="#wsk-cli-configure">Configuring</a></li>
+ </ul>
+ <li><a href="#wskdeploy">Whisk Deploy (wskdeploy)</a></li>
<li><a href="#rest-api">OpenWhisk REST API</a></li>
<li><a href="#openwhisk-clients">OpenWhisk Clients</a></li>
</ul>
@@ -161,7 +165,7 @@ <h4>Platform</h4>
</div>
<div class="project-structure-repo theme-deeper-sky-blue">
<h4>Runtimes</h4>
- <p>OpenWhisk supports several languages and runtimes.</p>
+ <p>OpenWhisk supports several languages via Docker runtime containers.</p>
<p class="repo-title border-deeper-sky-blue">
<a
href="https://github.com/apache/incubator-openwhisk-runtime-nodejs"
@@ -304,7 +308,7 @@ <h4>Tooling</h4>
</div>
<div class="project-structure-repo theme-darksalmon">
<h4>Packages</h4>
- <p>Several packages are registered with OpenWhisk under /whisk.system/. These are the list of packages:</p>
+ <p>Several common service integrations are made available as packages. By default they are registered in the OpenWHisk catalog, under the <em>/whisk.system/</em> namespace, and include:</p>
<p class="repo-title border-darksalmon">
<a
href="https://github.com/apache/incubator-openwhisk-package-alarms"
@@ -493,8 +497,8 @@ <h2>Operators</h2>
<!-- Deployment section under Operator -->
<main class="doc">
<div class="content">
- <a class="indexable" id="openwhisk_deployment"></a>
- <h3>OpenWhisk Deployment</h3>
+ <a class="indexable" id="openwhisk_architecture"></a>
+ <h3>OpenWhisk Architecture</h3>
<img style="padding-top:20px;" width="400px" src="https://raw.githubusercontent.com/apache/incubator-openwhisk/master/docs/images/OpenWhisk_flow_of_processing.png" alt="OpenWhisk Architecture"/>
<p>
The above diagram depicts the high-level architecture of OpenWhisk. From Nginx to Kafka to Docker,
@@ -502,9 +506,10 @@ <h3>OpenWhisk Deployment</h3>
You can read about the list of OpenWhisk components and its internal flow of processing
<a href="https://github.com/apache/incubator-openwhisk/blob/master/docs/about.md#the-internal-flow-of-processing">here</a>.
</p>
+ <a class="indexable" id="openwhisk_deployment"></a>
+ <h3>OpenWhisk Deployment</h3>
<p>
- OpenWhisk supports different installation methods for core OpenWhisk components.
- You can choose one of the following deployment methods based on your platform:
+ OpenWhisk supports different installation methods for core OpenWhisk platform components. You can choose one of the following deployment methods based on your platform:
</p>
<a class="indexable" id="deploy_docker_compose"></a>
<h4>Docker Compose</h4>
@@ -586,7 +591,7 @@ <h3>Administrative Operations</h3>
<main class="doc">
<div class="content">
<a class="indexable" id="operators_resources"></a>
- <h3>Operators Resources</h3>
+ <h3>Operator Resources</h3>
<ul>
<li><a href="https://medium.com/openwhisk/five-minute-intro-to-open-source-serverless-development-with-openwhisk-328b0ebfa160">Five minute intro to open source serverless development with OpenWhisk</a></li>
<li><a href="https://thenewstack.io/behind-scenes-apache-openwhisk-serverless-platform/">An Architectural View of Apache OpenWhisk</a></li>
@@ -640,9 +645,14 @@ <h4>Using OpenWhisk</h4>
<main class="doc">
<div class="content">
+ <a class="indexable" id="wsk-cli"></a>
+ <h4>OpenWhisk CLI (wsk)</h4>
+ <p>
+ OpenWhisk offers the <em>wsk</em> Command Line Interface (CLI) to easily create, run, and manage OpenWhisk entities.
+ </p>
<a class="indexable" id="wsk-cli-install"></a>
- <h5>Install the wsk CLI</h5>
+ <h5>Installing</h5>
<h6>Install the wsk with Homebrew (Mac & Linux)</h6>
<p>To easily install the OpenWhisk CLI (wsk) you can use <a href="https://brew.sh">Homebrew for Mac</a> or <a href="http://linuxbrew.sh">Homebrew for Linux</a>.</p>
@@ -674,18 +684,8 @@ <h6>Install the wsk CLI from a tar.gz (Windows):</h6>
<p>Then you can invoke the OpenWhisk CLI by just typing <code>wsk</code>.</p>
- </div>
- </main>
-
- <main class="doc">
- <div class="content">
-
-
- <a class="indexable" id="wsk-cli"></a>
- <h5>Configure the wsk CLI</h5>
- <p>
- OpenWhisk offers wsk Command Line Interface (CLI) to easily create, run, and manage OpenWhisk entities.
- </p>
+ <a class="indexable" id="wsk-cli-verify"></a>
+ <h5>Verifying</h5>
<ul>
<li>
<strong>CLI Help:</strong>
@@ -694,6 +694,10 @@ <h5>Configure the wsk CLI</h5>
{% highlight bash %}$ wsk --help{% endhighlight %}
</div>
</li>
+ </ul>
+ <a class="indexable" id="wsk-cli-configure"></a>
+ <h5>Configuring</h5>
+ <ul>
<li id="authentication">
<strong>Authenticate wsk CLI</strong>
<p>You can configure wsk CLI to use your OpenWhisk credentials in few different ways:</p>
@@ -721,11 +725,17 @@ <h5>Configure the wsk CLI</h5>
</ul>
</li>
</ul>
+
+ </div>
+ </main>
+
+ <main class="doc">
+ <div class="content">
<a class="indexable" id="wskdeploy"></a>
- <h5>Whisk Deploy</h5>
+ <h4>Whisk Deploy (wskdeploy)</h4>
<p>
<a href="https://github.com/apache/incubator-openwhisk-wskdeploy/blob/master/README.md">Whisk Deploy</a>
- is an utility to help deploy all your OpenWhisk Packages, Actions, Triggers, and Rules using a single command.
+ is a utility, named <em>wskdeploy</em>, to help deploy and manage all your OpenWhisk Packages, Actions, Triggers, Rules and APIs using a single command.
</p>
<ul>
<li>
@@ -761,16 +771,26 @@ <h5>Whisk Deploy</h5>
</ul>
</li>
</ul>
+ </div>
+ </main>
+
+ <main class="doc">
+ <div class="content">
<a class="indexable" id="rest-api"></a>
- <h5>OpenWhisk REST API</h5>
+ <h4>OpenWhisk REST API</h4>
<p>
After your OpenWhisk environment is enabled, you can use OpenWhisk with your web apps or mobile apps with REST API calls.
For more details about the APIs for actions, activations, packages, rules, and triggers, see the
<a href="https://github.com/apache/incubator-openwhisk/blob/master/docs/rest_api.md">OpenWhisk API</a>
documentation.
</p>
+ </div>
+ </main>
+
+ <main class="doc">
+ <div class="content">
<a class="indexable" id="openwhisk-clients"></a>
- <h5>OpenWhisk Clients</h5>
+ <h4>OpenWhisk Clients</h4>
<p>OpenWhisk provides a wrapper around the OpenWhisk APIs in multiple different languages.:</p>
<ul>
<li id="javascript-client"><a href="https://github.com/apache/incubator-openwhisk-client-js/blob/master/README.md">JavaScript</a></li>
@@ -788,7 +808,7 @@ <h5>OpenWhisk Clients</h5>
<h4>Actions</h4>
<p>
<strong>What is an OpenWhisk action?</strong>
- Actions are stateless functions(code snippets) that run on the OpenWhisk platform.
+ Actions are stateless functions (code snippets) that run on the OpenWhisk platform.
Actions encapsulates application logic to be executed in response to events.
You can find more details on specifics of an action in main OpenWhisk GitHub repo at
<a href="https://github.com/apache/incubator-openwhisk/blob/master/docs/actions.md">incubator-openwhisk</a>.
diff --git a/_layouts/home.html b/_layouts/home.html
index 127000e..579b1fb 100644
--- a/_layouts/home.html
+++ b/_layouts/home.html
@@ -16,6 +16,7 @@ <h5>Executes functions in response to events at any scale</h5>
<section id="whiskNodes">
<main>
+ <a class="indexable" id="what-is-openwhisk"></a>
<div class="content">
<h4>What is Apache OpenWhisk?</h4>
<p>
@@ -32,6 +33,7 @@ <h4>What is Apache OpenWhisk?</h4>
</main>
<main>
+ <a class="indexable" id="openwhisk-deployments"></a>
<div class="image-wrapper">
<img src="{{ site.github.url }}/images/illustrations/OW-Deployments.png" alt="Apache OpenWhisk can deploy on your favorite Cloud container framework."/>
</div>
@@ -44,6 +46,7 @@ <h4>Deploys anywhere</h4>
</main>
<main>
+ <a class="indexable" id="openwhisk-languages"></a>
<div class="content">
<h4>Write functions in any language</h4>
<!-- Possible text addition: "bundle larger or complex dependencies, and tailor the runtime environment to suite your needs."" -->
@@ -73,6 +76,7 @@ <h4>Write functions in any language</h4>
</main>
<main>
+ <a class="indexable" id="openwhisk-packages"></a>
<div class="image-wrapper">
<img src="{{ site.github.url }}/images/illustrations/OW-Integrations.png" alt="OpenWhisk's out-of-box packages easily integrate with our own services"/>
</div>
@@ -110,6 +114,7 @@ <h4>Integrate easily with many popular services</h4>
</main>
<main>
+ <a class="indexable" id="openwhisk-compositions"></a>
<div class="content">
<h4>Combine your functions into rich compositions</h4>
<p>
@@ -129,6 +134,7 @@ <h4>Combine your functions into rich compositions</h4>
</main>
<main>
+ <a class="indexable" id="openwhisk-benefits"></a>
<div class="image-wrapper">
<img src="{{ site.github.url }}/images/illustrations/OW-Utilization-Scaling.png" alt="Apache OpenWhisk automatically scales and maximizes and server utilization as events trigger action functions.">
</div>
@@ -143,6 +149,7 @@ <h4>Scaling Per-Request & Optimal Utilization</h4>
</main>
<main>
+ <a class="indexable" id="openwhisk-community"></a>
<div class="content">
<h4>Join a vibrant open source community</h4>
<p>
diff --git a/_scss/_base.scss b/_scss/_base.scss
index da2ac1a..b7cabbb 100644
--- a/_scss/_base.scss
+++ b/_scss/_base.scss
@@ -337,7 +337,7 @@ a.indexable {
a {
color: $color-index-fg;
text-decoration: none;
- display: block;
+ //display: block;
}
a:hover {
// use different color on index-item hover
diff --git a/_scss/_skin.scss b/_scss/_skin.scss
index 21b22ad..9925382 100644
--- a/_scss/_skin.scss
+++ b/_scss/_skin.scss
@@ -8,14 +8,9 @@ body {
font-family: $font-family-default;
}
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
- font-weight: $font-weight-bold;
- margin: 0;
+h1, h2, h3, h4, h5, h6 {
+ font-weight: $font-weight-bold;
+ margin: 0;
}
h1 {
@@ -44,24 +39,19 @@ h5 {
}
h6 {
- font-size: $h6-font-size;
- line-height: $h6-line-height;
+ font-size: $h6-font-size;
+ font-style: italic;
+ line-height: $h6-line-height;
}
-p,
-ul,
-ol,
-li {
- font-size: $p-font-size;
- font-weight: $p-font-weight;
- line-height: $p-line-height;
- color: $color-blue-dark-text;
+p, ul, ol, li {
+ font-size: $p-font-size;
+ font-weight: $p-font-weight;
+ line-height: $p-line-height;
+ color: $color-blue-dark-text;
}
-a,
-a:visited,
-a:hover,
-a:active {
+a, a:visited, a:hover, a:active {
color: $color-anchors;
}
diff --git a/_scss/_variables.scss b/_scss/_variables.scss
index a0ff1aa..597740b 100644
--- a/_scss/_variables.scss
+++ b/_scss/_variables.scss
@@ -157,7 +157,10 @@ $h4-font-size: 20px;
$h4-line-height: 28px;
$h5-font-size: 16px;
-$h5-line-height: 28px;
+$h5-line-height: 24px;
+
+$h6-font-size: 14px;
+$h6-line-height: 22px;
$h6-font-size: $font-size-default;
$h6-line-height: 24px;
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services