You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hive.apache.org by GitBox <gi...@apache.org> on 2022/11/01 09:34:29 UTC

[GitHub] [hive-site] zabetak commented on a diff in pull request #2: HIVE-26565: Revamp Apache Hive website

zabetak commented on code in PR #2:
URL: https://github.com/apache/hive-site/pull/2#discussion_r1010208962


##########
themes/hive/layouts/partials/footer.html:
##########
@@ -0,0 +1,55 @@
+<!---
+  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. -->
+
+<footer class="black-background static-bottom" style="padding:30px">
+    <div class="row">
+        <div class="col-3">
+            <a href="{{ .Site.Params.apache.apacheURL }}">
+                <img src="{{.Site.BaseURL}}{{ .Site.Params.logo }}" width="270" height="100"  alt="Apache Software Foundation"></a>
+            </a>
+        </div>
+        <div class="col-9">
+            <p class="footer-text">Apache is a non-profit organization helping open-source
+                software projects released under the Apache
+                <a href="{{ .Site.Params.apache.license }}">license</a>
+                and managed with
+                <a href="{{ .Site.Params.apache.howItWorks }}">
+                    open governance</a> and
+                <a href="{{ .Site.Params.apache.privacyPolicy }}">
+                    privacy policy</a>. See upcoming
+                <a href="{{ .Site.Params.apache.apacheEvents }}">Apache Events</a>.
+                If you discover any
+                <a href="{{ .Site.Params.apache.security }}">security</a> vulnerabilities, please
+                report them privately. Finally,
+                <a href="{{ .Site.Params.apache.sponsors }}">thanks
+                </a> to the sponsors who
+                <a href="{{ .Site.Params.apache.donate }}">
+                    donate</a> to the Apache Foundation.
+            </p>
+        </div>
+
+
+    </div>
+    <div class="copyright row">
+        <a href="{{ .Site.BaseURL }}" style="color:grey">
+            {{ with .Site.Params.Apache.Copyright | default .Site.Title }} {{ . | safeHTML }} {{ end }}
+        </a>
+    </div>
+
+</footer>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>

Review Comment:
   Add new line.



##########
README.md:
##########
@@ -1,24 +1,55 @@
-# Apache Hive docs site
+# Apache Hive Documentation Site
 
-This directory contains the code for the Apache Hive web site,
-[hive.apache.org](https://hive.apache.org/). The easiest way to build
-the site is to use docker to use a standard environment.
+This repository contains the documentation for Apache Hive. 

Review Comment:
   Suggestion: This repository contains the code for generating the Apache Hive web site.



##########
themes/hive/layouts/partials/header.html:
##########
@@ -0,0 +1,20 @@
+<!---
+  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. -->
+<header>
+    {{- partial "menu.html" . -}}
+</header>

Review Comment:
   Add all missing new lines.



##########
config.toml:
##########
@@ -0,0 +1,51 @@
+baseURL = 'https://simhadri-g.github.io/hive-site'

Review Comment:
   Change the URL to point to the correct location.



##########
themes/hive/layouts/partials/head.html:
##########
@@ -0,0 +1,38 @@
+<!-- - 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.-->

Review Comment:
   Not the same license header with the other html files.



##########
content/general/PrivacyPolicy.md:
##########
@@ -21,15 +22,18 @@ layout: default
   specific language governing permissions and limitations
   under the License. -->
 
+# Privacy Policy
+--- 
+
 Information about your use of this website is collected using server
 access logs and a tracking cookie. The collected information consists of
 the following:
 
-  1. The IP address from which you access the website;
-  2. The type of browser and operating system you use to access our site;
-  3. The date and time you access our site;
-  4. The pages you visit; and
-  5. The addresses of pages from where you followed a link to our site.
+1. The IP address from which you access the website;
+2. The type of browser and operating system you use to access our site;
+3. The date and time you access our site;
+4. The pages you visit; and
+5. The addresses of pages from where you followed a link to our site.
 
 Part of this information is gathered using a tracking cookie set by the
 <a href="http://www.google.com/analytics/">Google Analytics</a>

Review Comment:
   I suppose we are going to handle HIVE-26166 as a follow up right?



##########
hcatalog_downloads.md:
##########
@@ -1,43 +0,0 @@
----
-title: HCatalog Downloads

Review Comment:
   Is there a replacement for this file?



##########
themes/hive/static/js/script.js:
##########
@@ -0,0 +1,102 @@
+var canvas = document.getElementById("canvas"),

Review Comment:
   What is the LICENSE for this file? Did you write it or did you take it somewhere else?



##########
themes/hive/static/css/termynal.css:
##########
@@ -0,0 +1,91 @@
+/**
+ * termynal.js

Review Comment:
   Should the file have an MIT header?



##########
themes/hive/theme.toml:
##########
@@ -0,0 +1,21 @@
+# theme.toml template for a Hugo theme

Review Comment:
   What is this file used for? The values for certain elements below seem wrong.



##########
themes/hive/static/js/termynal.js:
##########
@@ -0,0 +1,203 @@
+/*

Review Comment:
   Should the file come with MIT header?



##########
.github/workflows/gh-pages.yml:
##########
@@ -0,0 +1,36 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main  # Set a branch to deploy
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true  # Fetch Hugo themes (true OR recursive)
+          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.91.2'
+          # extended: true
+
+      - name: Build
+        run: hugo --minify
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+          publish_branch: asf-site
+          destination_dir: ./
+          keep_files: true

Review Comment:
   Add new line: https://unix.stackexchange.com/questions/18743/whats-the-point-in-adding-a-new-line-to-the-end-of-a-file



##########
themes/hive/layouts/_default/baseof.html:
##########
@@ -0,0 +1,11 @@
+<!DOCTYPE html>

Review Comment:
   Add missing Apache LICENCE header in this and other .html/.md files.



##########
doap_Hive.rdf:
##########
@@ -1,58 +0,0 @@
-<?xml version="1.0"?>

Review Comment:
   Do we need to delete this file?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hive.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org