From 195b9e8408399f16d7c7f3ad22be57ef85977f6c Mon Sep 17 00:00:00 2001 From: bruno Date: Sun, 15 Sep 2024 22:08:03 +0200 Subject: [PATCH 1/8] fixed k3s/_index --- .../installation/prereq/server/k3s/_index.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/content/en/docs/installation/prereq/server/k3s/_index.md b/content/en/docs/installation/prereq/server/k3s/_index.md index 79f9c3cd..c54c2395 100644 --- a/content/en/docs/installation/prereq/server/k3s/_index.md +++ b/content/en/docs/installation/prereq/server/k3s/_index.md @@ -23,7 +23,7 @@ prerequisites](#../../../prereq/index.adoc), most notably: 1. you know the **IP address or DNS name** 2. your server operating system satisfies the [K3S - requirements](https://docs.k3s.io/installation/requirements) + requirements](https://docs.k3s.io/installation/requirements) 3. you have passwordless access with ssh @@ -33,10 +33,11 @@ prerequisites](#../../../prereq/index.adoc), most notably: Then you can use the following subcommand to install in the server: - ops cloud k3s create SERVER= USERNAME= + ops cloud k3s create [] where `` is the **IP address or DNS name** to access the server, -and `` is the user you use to access the server. +and the optional `` is the user you use to access the server: +if is not specified, the `root` username will be used. Those pieces of information should have been provided when provisioning the server. @@ -44,8 +45,8 @@ the server. > ❗ **IMPORTANT** > > If you installed a Kubernetes cluster in the server this way, you should -proceed installing OpenServerless as in -[a Kubernetes cluster](/docs/installation/install/cluster/), **not** +proceed installing OpenServerless as in +[a Kubernetes cluster](/docs/installation/install/cluster/), **not** as a server. The installation retrieves also a Kubernetes configuration file, so you @@ -55,11 +56,11 @@ can proceed to installing it without any other step involved. In addition to `create` the following subcommands are also available: -- `ops cloud k3s delete SERVER= USERNAME=`: - uninstall K3S from the server +- `ops cloud k3s delete []`: + uninstall K3S from the server -- `ops cloud k3s kubeconfig SERVER= USERNAME=`: - retrieve the kubeconfig from the K3S server +- `ops cloud k3s kubeconfig []`: + retrieve the kubeconfig from the K3S server - `ops cloud k3s info`: some information about the server From 9dab09eca168b9030740d9b37661107e19b71da2 Mon Sep 17 00:00:00 2001 From: Bruno Salzano Date: Wed, 16 Oct 2024 22:40:01 +0200 Subject: [PATCH 2/8] chore: download page Completed doc in download page --- .../en/docs/installation/download/_index.md | 31 +++++++++++++++---- hugo.yaml | 8 ++--- 2 files changed, 29 insertions(+), 10 deletions(-) diff --git a/content/en/docs/installation/download/_index.md b/content/en/docs/installation/download/_index.md index 92ac3d83..1f2a592f 100644 --- a/content/en/docs/installation/download/_index.md +++ b/content/en/docs/installation/download/_index.md @@ -6,18 +6,33 @@ draft: false --- ## Download and Install `ops` -🚧 PAGE UNDER CONSTRUCTION 🚧 +### What is `ops`? + +As you can guess it helps with operations: ops is the OPenServerless CLI. + +It is a task executor on steroids. + +- it embeds task, wsk and a lot of other utility commands (check with ops -help) +- automatically download and update command line tools, prerequisites and tasks +- taskfiles are organized in commands and subcommands, hierarchically and are powered by docopt +- it supports plugins + +The predefined set of tasks are all you need to install and manage an OpenServerless cluster. ### Download links You can install OpenServerless using its Command Line Interface, `ops`. -You can download it for your system. It is available for the following -operating systems, architectures and formats: +Quick install in Linux, MacOS and Windows with WSL or GitBash: - PUT HERE THE DOWNLOADS +```bash +curl -sL bit.ly/get-ops | bash +``` -Download your version from this page, then install it according to the -procedures of your operating system. +Quick install in Windows with PowerShell + +```powershell +irm bit.ly/get-ops-exe | iex +``` ### After the installation @@ -35,3 +50,7 @@ tasks are continuously evolving and expanding. You normally just need to update the tasks but sometimes you also need to update `ops` itself. The system will detect when it is the case and tell you what to do. + +### Where to find more details: + +For more details, please visit the Github page of [Openserverless Cli](https://github.com/apache/openserverless-cli) \ No newline at end of file diff --git a/hugo.yaml b/hugo.yaml index aac2ec35..edf50229 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -186,10 +186,10 @@ params: url: https://the-asf.slack.com/archives/C07B6K5R3F0 icon: fab fa-slack desc: Chat with other project developers - #- name: Telegram - # url: https://t.me/+XhbCjBrkkaNkOWM0 - # icon: fab fa-telegram - # desc: A public telegram group to discuss everything about OpenServerless + - name: Telegram + url: https://t.me/+XhbCjBrkkaNkOWM0 + icon: fab fa-telegram + desc: A public telegram group to discuss everything about OpenServerless module: # Uncomment the next line to build and serve using local docsy clone declared in the named Hugo workspace: From 320b27ed11baeb217c75abb3432e1ef88a320e7f Mon Sep 17 00:00:00 2001 From: Bruno Salzano Date: Sat, 19 Oct 2024 19:14:54 +0200 Subject: [PATCH 3/8] chore: fix tutorial page fixed download link in tutorial --- content/en/docs/tutorial/getting-started/_index.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/content/en/docs/tutorial/getting-started/_index.md b/content/en/docs/tutorial/getting-started/_index.md index 44c9d7e7..46ca3cbc 100644 --- a/content/en/docs/tutorial/getting-started/_index.md +++ b/content/en/docs/tutorial/getting-started/_index.md @@ -4,6 +4,7 @@ description: Let's start building a sample application weight: 10 draft: false --- + ## Getting started ### Build a sample Application @@ -28,8 +29,8 @@ allows you to deploy (and interact with) the platform seamlessly to the cloud, locally and in custom environments. Ops is cross-platform and can be installed on Windows, Linux and MacOS. -You can find it here: [Ops -Releases](https://github.com/nuvolaris/nuv/releases) +You can find the project and the sources on +[Apache OpenServerless Cli Github page](https://github.com/apache/openserverless-cli) ### Deploy OpenServerless @@ -42,10 +43,10 @@ come back here! ### Enabling Services -We also want to enable some extra services: a Postgres database, Static -content with the Minio storage and a cron scheduler. We will use them -shortly to upload frontend and store the data for our app! Let’s run in -the terminal: +After installing OpenServerless on a local machine with Docker or on a +supported cloud, you can enable or disable the services offered by the platform. +As we will use Postgres database, the Static content with the Minio S3 compatible +storage and a cron scheduler, let’s run in the terminal: ```bash ops config enable --postgres --static --minio --cron @@ -69,4 +70,5 @@ run: ```bash ops config disable --postgres --static --minio --cron ``` + --- From d352e2b751196530c0f06e3f6e68e49f6e6d3aff Mon Sep 17 00:00:00 2001 From: Bruno Salzano Date: Mon, 28 Oct 2024 07:35:22 +0100 Subject: [PATCH 4/8] chore: asf links added asf link and removed external assets --- .github/workflows/build.yml | 8 +- assets/scss/_styles_project.scss | 8 ++ content/en/_index.md | 12 +-- .../en/docs/installation/download/_index.md | 4 + hugo.yaml | 31 ++++++- layouts/partials/footer.html | 2 +- layouts/partials/head.html | 57 ++++++++++++ layouts/partials/navbar.html | 87 +++++++++++++++++++ static/css/docsearch-3.6.0.min.css | 8 ++ static/js/jquery-3.7.1.min.js | 2 + static/js/lunr-2.3.9.min.js | 6 ++ 11 files changed, 213 insertions(+), 12 deletions(-) create mode 100644 layouts/partials/head.html create mode 100644 layouts/partials/navbar.html create mode 100644 static/css/docsearch-3.6.0.min.css create mode 100644 static/js/jquery-3.7.1.min.js create mode 100644 static/js/lunr-2.3.9.min.js diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c24a3e8c..744188f0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,9 +1,9 @@ name: test -#on: -# push: -# branches: -# - main +on: + push: + branches: + - main env: PUBLISH_DIRECTORY: public diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index 4909431c..b2fc9f75 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -103,4 +103,12 @@ aside{ .ops-asciinema-ext { width: 600px; /* For screens wider than 450px, set the width to 450px */ } +} + +.dropdown-menu { + display: block; + position: absolute; + transform: translate3d(0, 0, 0); /* Adjusts visibility and position */ + visibility: visible; + opacity: 1; } \ No newline at end of file diff --git a/content/en/_index.md b/content/en/_index.md index 6d907105..45302993 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -1,8 +1,8 @@ --- -title: Apache OpenServerless +title: Apache OpenServerless™ --- -{{< blocks/cover title="Welcome to Apache OpenServerless!" height="full" >}} +{{< blocks/cover title="Welcome to Apache OpenServerless™!" height="full" >}} Learn More @@ -17,16 +17,16 @@ title: Apache OpenServerless {{% blocks/lead color="primary" %}} -

Apache OpenServerless is a distribution, running in any Kubernetes Clusters or even plain Linux Virtual Machine, straightforward to install and easy to use, deploying a Serverless Enviroment ready to use to build A.I. applications.

+

Apache OpenServerless™ is a distribution, running in any Kubernetes Clusters or even plain Linux Virtual Machine, straightforward to install and easy to use, deploying a Serverless Enviroment ready to use to build A.I. applications.

-

Apache OpenServerless lets you stop worrying of building, deploying, configuring and orchestrating containers. You can focus on writing your A.I. code and run it anywere, production ready, without any vendor-lockin.

+

Apache OpenServerless™ lets you stop worrying of building, deploying, configuring and orchestrating containers. You can focus on writing your A.I. code and run it anywere, production ready, without any vendor-lockin.

{{% /blocks/lead %}} {{% blocks/section color="dark" type="row" %}} {{% blocks/feature icon="fab fa-reddit" title="Join our subreddit!" url="https://reddit.com/r/openserverless" %}} -A friendly place to discuss Apache OpenServerless +A friendly place to discuss Apache OpenServerless™ {{% /blocks/feature %}} @@ -49,7 +49,7 @@ For announcement of latest features etc. {{% blocks/section %}} {{% imgproccenter openserverless-diagram.webp Fit "3456x1728" "rounded-image" %}} -Apache OpenServerless Architecture Overview +Apache OpenServerless™ Architecture Overview {{% /imgproccenter %}} {{% /blocks/section %}} diff --git a/content/en/docs/installation/download/_index.md b/content/en/docs/installation/download/_index.md index 1f2a592f..38190f36 100644 --- a/content/en/docs/installation/download/_index.md +++ b/content/en/docs/installation/download/_index.md @@ -22,6 +22,10 @@ The predefined set of tasks are all you need to install and manage an OpenServer ### Download links You can install OpenServerless using its Command Line Interface, `ops`. +{{< blockquote warning >}} +Since we are in a preview phase, this is not an official link approved by the Apache Software Foundation. +{{< /blockquote >}} + Quick install in Linux, MacOS and Windows with WSL or GitBash: ```bash diff --git a/hugo.yaml b/hugo.yaml index edf50229..67799872 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -1,5 +1,5 @@ baseURL: "/" -title: "Apache OpenServerless" +title: "Apache OpenServerless™" cSpell: ignore github hugo readingtime subdir lastmod pygments linenos OpenServerless @@ -68,6 +68,35 @@ markup: outputs: section: [HTML, print, RSS] +menus: + main: + - name: "Apache Software Foundation" + url: "#" + - name: "Apache Homepage" + parent: "Apache Software Foundation" + url: "https://www.apache.org/" + weight: 1 + - name: "License" + parent: "Apache Software Foundation" + url: "https://www.apache.org/licenses/" + weight: 2 + - name: "Sponsorship" + parent: "Apache Software Foundation" + url: "https://www.apache.org/foundation/sponsorship.html" + weight: 3 + - name: "Thanks" + parent: "Apache Software Foundation" + url: "https://www.apache.org/foundation/thanks.html" + weight: 4 + - name: "Security" + parent: "Apache Software Foundation" + url: "https://www.apache.org/security/" + weight: 5 + - name: "Events" + parent: "Apache Software Foundation" + url: "https://www.apache.org/events/current-event" + weight: 6 + params: taxonomy: # set taxonomyCloud = [] to hide taxonomy clouds diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 2f75672e..3f45e8c5 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -5,7 +5,7 @@