init ESA Stack website

.github/workflows/gh-pages.yaml

@@ -0,0 +1,48 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - main  # Set a branch to deploy
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    defaults:
+      run:
+        working-directory: .
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive  # Fetch the Docsy theme
+          fetch-depth: 0         # Fetch all history for .GitInfo and .Lastmod
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.92.2'
+          extended: true
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: hugo
+        env:
+          HUGO_ENV: production
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: public
+          cname: www.esastack.io

.gitignore

@@ -0,0 +1,11 @@
+# idea ignore
+.idea/
+
+# vscode files
+.vscode/
+
+# site resources
+public/
+resources/
+node_modules/
+.hugo_build.lock

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/docsy"]
+	path = themes/docsy
+	url = https://github.com/google/docsy

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+## Contributing
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository
+2. Create a new branch: `git checkout -b my-branch-name`
+3. Make your change and remember to add tests
+4. Build the project locally and run local tests
+5. Push to your fork and [submit a pull request][pr]
+6. Pat your self on the back and wait for your pull request to be reviewed and merged.
+
+Thanks for your contributing!

README.md

@@ -1,2 +1,37 @@
-# website
-ESA Stack Website
+# ESA ESA Stack website
+The document website is hosted at https://www.esastack.io.
+
+We use [Hugo](https://gohugo.io/) with the [google/docsy](https://github.com/google/docsy)
+theme for styling and site structure, and [Github Actions](https://docs.github.com/en/actions) to manage the deployment of the site.
+
+## Local development
+
+This section will show you how to develop the website locally, by running a local Hugo server.
+
+### Install Hugo
+
+To install Hugo, follow the [instructions for your system type](https://gohugo.io/getting-started/installing/).
+
+### Install Node Packages
+
+Follow the [Docsy getting started](https://www.docsy.dev/docs/getting-started/#as-an-npm-module) and [Docsy InstallPostCss](https://www.docsy.dev/docs/getting-started/#install-postcss) to install node packages. You may need to install NodeJs if there's no NodeJs in you local environment.
+
+### Run Hogo Server
+
+1. Switch to the site root
+
+```text
+cd site
+```
+
+2. Get local copies of the project submodules so you can build and run your site locally:
+
+```text
+git submodule update --init --recursive
+```
+3. Build your site:
+
+```text
+hugo server
+```
+Preview your site in your browser at: http://localhost:1313/. You can use `Ctrl + c` to stop the Hugo server whenever you like.

assets/scss/_variables_project.scss

@@ -0,0 +1,8 @@
+/*
+
+Add styles or override variables from the theme here.
+
+*/
+
+
+$primary: #24292f !default;

config.toml

@@ -0,0 +1,235 @@
+baseURL = "/"
+title = "ESA Stack"
+description = "Elastic Service Architecture"
+
+enableRobotsTXT = true
+
+# Hugo allows theme composition (and inheritance). The precedence is from left to right.
+theme = ["docsy"]
+
+# Will give values to .Lastmod etc.
+enableGitInfo = true
+
+# Language settings
+contentDir = "content/en"
+defaultContentLanguage = "en"
+defaultContentLanguageInSubdir = false
+# Useful when translating.
+enableMissingTranslationPlaceholders = true
+
+# Comment out to enable taxonomies in Docsy
+# disableKinds = ["taxonomy", "taxonomyTerm"]
+
+# You can add your own taxonomies
+[taxonomies]
+tag = "tags"
+category = "categories"
+
+[params.taxonomy]
+# set taxonomyCloud = [] to hide taxonomy clouds
+taxonomyCloud = ["tags", "categories"] 
+
+# If used, must have same lang as taxonomyCloud
+taxonomyCloudTitle = ["Tag Cloud", "Categories"] 
+
+# set taxonomyPageHeader = [] to hide taxonomies on the page headers
+taxonomyPageHeader = ["tags", "categories"] 
+
+
+# Highlighting config
+pygmentsCodeFences = true
+pygmentsUseClasses = false
+# Use the new Chroma Go highlighter in Hugo.
+pygmentsUseClassic = false
+#pygmentsOptions = "linenos=table"
+# See https://help.farbox.com/pygments.html
+pygmentsStyle = "tango"
+
+# Configure how URLs look like per section.
+[permalinks]
+blog = "/:section/:year/:month/:day/:slug/"
+
+## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
+[blackfriday]
+plainIDAnchors = true
+hrefTargetBlank = true
+angledQuotes = false
+latexDashes = true
+
+# Image processing configuration.
+[imaging]
+resampleFilter = "CatmullRom"
+quality = 75
+anchor = "smart"
+
+[services]
+[services.googleAnalytics]
+# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
+id = "UA-00000000-0"
+
+# Language configuration
+
+[languages]
+[languages.en]
+title = "ESA Stack"
+description = "Elastic Service Architecture"
+languageName ="English"
+# Weight used for sorting.
+weight = 1
+
+[menu]
+#  [[menu.main]]
+#    name = "Docs"
+#    weight = 1
+#    pre = "<i class='fas fa-book pr-2'></i>"
+#    url = "/docs/"
+  [[menu.main]]
+    name = "Blog"
+    weight = 2
+    pre = "<i class='fas fa-rss pr-2'></i>"
+    url = "/blog/"
+  [[menu.main]]
+    name = "Github"
+    weight = 3
+    pre = "<i class='fab fa-github pr-2'></i>"
+    url = "https://github.com/esastack"
+
+[markup]
+  [markup.goldmark]
+    [markup.goldmark.renderer]
+      unsafe = true
+  [markup.highlight]
+    # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
+    style = "tango"
+    # Uncomment if you want your chosen highlight style used for code blocks without a specified language
+    # guessSyntax = "true"
+
+# Everything below this are Site Params
+
+# Comment out if you don't want the "print entire section" link enabled.
+[outputs]
+section = ["HTML", "print", "RSS"]
+
+[params]
+copyright = "OPPO ESA Stack Project"
+# privacy_policy = "https://policies.google.com/privacy"
+
+# First one is picked as the Twitter card image if not set on page.
+# images = ["images/project-illustration.png"]
+
+# Menu title if your navbar has a versions selector to access old versions of your site.
+# This menu appears only if you have at least one [params.versions] set.
+version_menu = "Versions"
+
+project_menu = "Projects"
+
+# Flag used in the "version-banner" partial to decide whether to display a 
+# banner on every page indicating that this is an archived version of the docs.
+# Set this flag to "true" if you want to display the banner.
+archived_version = false
+
+# The version number for the version of the docs represented in this doc set.
+# Used in the "version-banner" partial to display a version number for the 
+# current doc set.
+version = "0.0"
+
+# A link to latest version of the docs. Used in the "version-banner" partial to
+# point people to the main doc site.
+url_latest_version = "https://www.esastack.io/docs/"
+
+# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
+github_repo = "https://github.com/esastack/website"
+# An optional link to a related project repo. For example, the sibling repository where your product code lives.
+github_project_repo = "https://github.com/esastack"
+
+# Specify a value here if your content directory is not in your repo's root directory
+#github_subdir = "site"
+
+# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
+# or specify a new value if you want to reference another branch in your GitHub links
+github_branch= "main"
+
+# Google Custom Search Engine ID. Remove or comment out to disable search.
+gcs_engine_id = "d72aa9b2712488cc3"
+
+# Enable Algolia DocSearch
+algolia_docsearch = true
+
+# Enable Lunr.js offline search
+offlineSearch = false
+
+# Enable syntax highlighting and copy buttons on code blocks with Prism
+prism_syntax_highlighting = false
+
+# User interface configuration
+[params.ui]
+#  Set to true to disable breadcrumb navigation.
+breadcrumb_disable = false
+# Set to true to disable the About link in the site footer
+footer_about_disable = false
+# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
+navbar_logo = true
+# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
+navbar_translucent_over_cover_disable = false
+# Enable to show the side bar menu in its compact state.
+sidebar_menu_compact = true
+sidebar_menu_foldable = true
+# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
+sidebar_search_disable = false
+
+# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
+# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
+# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
+# add "hide_feedback: true" to the page's front matter.
+[params.ui.feedback]
+enable = true
+# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
+yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
+no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
+
+# Adds a reading time to the top of each doc.
+# If you want this feature, but occasionally need to remove the Reading time from a single page, 
+# add "hide_readingtime: true" to the page's front matter
+[params.ui.readingtime]
+enable = false
+
+[params.links]
+# End user relevant links. These will show up on left side of footer and in the community page if you have one.
+[[params.links.user]]
+  name = "User mailing list"
+  url = "mailto:esa.stack@oppo.com"
+  icon = "fa fa-envelope"
+  desc = "Discussion and help from your fellow users"
+[[params.links.developer]]
+  name = "GitHub"
+  url = "https://github.com/esastack"
+  icon = "fab fa-github"
+  desc = "Development takes place here!"
+[[params.links.developer]]
+  name = "Developer mailing list"
+  url = "mailto:esa.stack@oppo.com"
+  icon = "fa fa-envelope"
+  desc = "Discuss development issues around the project"
+
+# projects
+[[params.projects]]
+  project = "ESA Restlight"
+  url = "https://www.esastack.io/esa-restlight"
+[[params.projects]]
+  project = "ESA RestClient"
+  url = "https://restclient.esastack.io"
+[[params.projects]]
+  project = "ESA ServiceKeeper"
+  url = "https://www.esastack.io/esa-servicekeeper"
+[[params.projects]]
+  project = "ESA Cabin"
+  url = "https://github.com/esastack/esa-cabin"
+[[params.projects]]
+  project = "ESA HttpServer"
+  url = "https://github.com/esastack/esa-httpserver"
+[[params.projects]]
+  project = "ESA Codec Dubbo"
+  url = "https://github.com/esastack/esa-codec-dubbo"
+[[params.projects]]
+  project = "ESA Commons"
+  url = "https://github.com/esastack/esa-commons"