[incubator-hop-website] branch asf-site updated: Add files to make buildscript work

[ha...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hansva pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hop-website.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new abb369e  Add files to make buildscript work
abb369e is described below

commit abb369e0a0410f8f4b61cea2fbc419fb30cce1aa
Author: Hans Van Akelyen <ha...@gmail.com>
AuthorDate: Wed Oct 14 18:29:42 2020 +0200

    Add files to make buildscript work
---
 .asf.yaml |  30 +++++++++++++++++
 README.md | 114 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 144 insertions(+)

diff --git a/.asf.yaml b/.asf.yaml
new file mode 100644
index 0000000..3040ce4
--- /dev/null
+++ b/.asf.yaml
@@ -0,0 +1,30 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+notifications:
+  pullrequests: commits@hop.apache.org
+  jira_options: link label comment
+publish:
+  whoami: asf-site
+github:
+  description: "Apache Hop Website"
+  labels:
+    - hop
+  enabled_merge_buttons:
+    squash:  true
+    merge:   true
+    rebase:  true
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..13945db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,114 @@
+# Hop Website
+
+This repository is used to generate the Hop website
+
+Tools used to generate the website:
+
+ - [Git](https://git-scm.com/) a source code management tool used to fetch document sources from different
+   github repositories.
+ - [Node.js](https://nodejs.org/) a JavaScript runtime used to build the website. You will need to use Node.js version 10.
+ - [yarn](https://yarnpkg.com/) a blazing fast dependency and package manager tool used to download
+   and manage required libraries.
+ - (installed via yarn) [Gulp](http://gulpjs.com/) a task automation tool. Used to build the Hop
+   Antora UI theme.
+ - (installed via yarn) [Hugo](https://gohugo.io) a static site generator. Simplified, it takes the
+   documentation from the `content` directory and applies templates from `layouts`
+   directory and together with any resources in `static` directory generates output in
+   the `public` directory.
+ - (installed via yarn) [Antora](https://antora.org/) a documentation site generator. It uses
+   Asciidoc documents from different sources.
+
+## Build with Node and yarn
+
+You can build the website locally using the tools `Node.js` and `yarn`.
+
+
+### Preparing the tools
+
+#### Node
+
+Make sure that you have Node.js (herein "`Node`") installed.
+
+    $ node --version
+
+If this command fails with an error, you do not have Node installed.
+
+This project requires the Node LTS version 10 (e.g., v10.15.3).
+
+Please make sure to have a suitable version of Node installed. You have several options to install
+Node on your machine.
+
+- Install using the Node version manager [nvm](https://github.com/creationix/nvm)
+- Install using [Homebrew](https://brew.sh/) and [Node formulae](https://formulae.brew.sh/formula/node)
+- Install from official [Node packages](https://nodejs.org/en/download/)
+
+Note - If you have different Node version other than Node LTS version 10 you can use following command to make
+Node LTS version 10 as default Node version.
+
+    $ nvm alias default 10
+
+Now that you have Node 10 installed, you can proceed with checking the Yarn installation.
+
+#### Yarn
+
+Follow [the documentation on installing](https://yarnpkg.com/en/docs/install) Yarn for your Operating system.
+
+#### Clone and Initialize the project
+
+Clone the hop-webiste git repository:
+
+    $ git clone https://github.com/apache/hincubator-op-website.git
+
+
+## Build the Antora Hop UI theme
+
+First step is to build the Antora ui theme used for the Hop website. The theme sources are located
+inside [Project root directory/antora-ui-hop](antora-ui-hop). So first switch to that directory:
+
+    $ cd antora-ui-hop
+
+In that directory execute:
+
+    $ yarn install # needed only once, or if dependencies change
+    $ yarn build   # to perform the ui theme build
+
+You should see the Antora theme bundle generated in [antora-ui-hop/build/ui-bundle.zip](antora-ui-hop).
+
+## Build the website content
+
+Before you are able to build the website content the ui bundle must be present.
+
+To build the website go to the project root directory and run:
+
+    $ yarn install # needed only once, or if dependencies change
+    $ yarn build   # to perform the build
+
+You should see the generated website in the `public` directory.
+
+## Preview website locally
+
+You can preview the the website on your local machine once you have the generated website available in
+the `public` directory.
+
+Hugo can start a simple web server serving the generated site content so you can view it in your favorite browser.
+
+Simply call
+
+    $ yarn preview
+
+and you will be provided with a web server running the site on [http://localhost:1313/](http://localhost:1313/)
+
+Point your favorite browser to `http://localhost:1313/` and you will see the Hop website.
+
+## Contributing
+
+The website content is added under the `content` directory, logical groups have been created to group website content. This repository will only be used for the more "static" types of information (blog/news/announcements). Software documentation will reside in a seperate repository or in the same repository as the code.
+
+Asciidoc is used to write content for the website, more information about asciidoc syntax can be found [here](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
+
+Images and other resources should be added in the `static` folder.
+
+## Jenkins
+This repository also contains a Jenkins hook, when you add a new branch or pull request with changed content the website is automatically build and a preview is available. When merged with master the site is redeployed
+
+You can check your pull request and see if the site is correctly rendered by going to the [Apache Builds website](https://ci-builds.apache.org/job/Hop/)