You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@age.apache.org by ey...@apache.org on 2021/02/09 20:55:52 UTC

[incubator-age] 08/18: Added team, contribution, footer

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

eya pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-age.git

commit b760e0a2cdfe3804fb86cdb6652dff48c9eb7087
Author: Nick Sorrell <ni...@cint.io>
AuthorDate: Wed Dec 2 14:35:11 2020 -0500

    Added team, contribution, footer
---
 assets/images/incubator_ring_logo.png | Bin 0 -> 28717 bytes
 assets/scripts/index.js               |   7 +-
 assets/styles/index.css               |  75 +++++++++++-
 index.html                            | 225 +++++++++++++++++++++++++++++++++-
 4 files changed, 301 insertions(+), 6 deletions(-)

diff --git a/assets/images/incubator_ring_logo.png b/assets/images/incubator_ring_logo.png
new file mode 100755
index 0000000..30bf2cb
Binary files /dev/null and b/assets/images/incubator_ring_logo.png differ
diff --git a/assets/scripts/index.js b/assets/scripts/index.js
index 31f7d9e..2253c2b 100644
--- a/assets/scripts/index.js
+++ b/assets/scripts/index.js
@@ -36,6 +36,11 @@ var handleMenuClick = function (el) {
   if (display === "none") {
     sidebar.style.display = "block";
   } else {
-    sidebar.style.display = "none";
+    sidebar.style.gridColumn = 0;
   }
+}
+
+var handleJiraSearch = function () {
+  let searchTerms = document.getElementById("jira-search").value;
+  window.open(`https://issues.apache.org/jira/browse/AGE-1?jql=(project%3DAGE)%20and%20text%20~%20%22${searchTerms}%22`, "_blank");
 }
\ No newline at end of file
diff --git a/assets/styles/index.css b/assets/styles/index.css
index 9702ea2..25f781a 100644
--- a/assets/styles/index.css
+++ b/assets/styles/index.css
@@ -60,6 +60,7 @@
   }
 }
 
+
 .sidebar--selected {
   border-bottom: 1px dotted blue;
 }
@@ -77,7 +78,6 @@
  *   MAIN AREA 
  */
 
-
 .main {
   grid-column: 2 / 3;
   grid-row: 2;
@@ -102,9 +102,30 @@
 }
 
 /*
+ *   FOOTER 
+ */
+
+.footer {
+  width: 100%;
+  margin-bottom: 2rem;
+  font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+}
+
+.footer-img {
+  display: block;
+  margin: auto;
+}
+
+
+/*
  *   GENERAL 
  */
 
+ .center {
+   text-align: center;
+   margin: auto;
+ }
+
 .emph {
   font-weight: 700;
 }
@@ -118,6 +139,7 @@
 .subtitle {
   font-size: 2rem;
   padding-left: 1rem;
+  padding-top: 1rem;
 }
 
 .code {
@@ -132,7 +154,58 @@
   overflow: auto;
 }
 
+.inline-code {
+  background-color: lightgray;
+  font-family: "Courier New", Courier, monospace;
+  padding-left: .4rem;
+  padding-right: .4rem;
+}
+
 .external-link::after {
   color: blue;
   content: "➚";
 }
+
+.mail-link::after {
+  color: red;
+  content: "✉"
+}
+
+.search {
+  line-height: 2rem;
+}
+
+br {
+  content: "";
+  margin: 2em;
+  display: block;
+  font-size: 24%;
+}
+
+table {
+  border-collapse: collapse;
+  border: 2px solid black;
+  width: 80%;  
+}
+thead,
+tfoot {
+    background-color: lightblue;
+    font-size: 1.2rem;  
+}
+
+tbody {
+    background-color: #e4f0f5;
+}
+
+td,
+th {
+  border: 1px solid black;
+  padding: 5px 10px;
+  width: 40%;
+}
+tr:nth-child(even) { 
+  background-color: lightgrey; 
+} 
+td {
+  text-align: center;
+}
\ No newline at end of file
diff --git a/index.html b/index.html
index e5ddccf..047faa7 100644
--- a/index.html
+++ b/index.html
@@ -46,15 +46,14 @@
 
         <p class="sidebar--section">
           <span class="emph">CONTRIBUTION</span> <br />
-          Welcome <br />
-          Committer Guide <br />
+          <span id="sidebar-contribute" class="sidebar-item"> <a class="sidebar-link" href="#" onclick="handleClick(this)">How to Contribute</a></span> <br />          
           Coding Guideline <br />
         </p>
 
         <p class="sidebar--section">
           <span class="emph">COMMUNITY</span> <br />
-          Team <br />
-          Mailing List <br />
+          <span id="sidebar-team" class="sidebar-item"> <a class="sidebar-link" href="#" onclick="handleClick(this)">Team</a></span> <br />          
+          <span id="sidebar-mailinglists" class="sidebar-item"> <a class="sidebar-link" href="#" onclick="handleClick(this)">Mailing Lists</a></span> <br />          
           <a class="sidebar-link external-link" target="_blank" href="https://issues.apache.org/jira/projects/AGE/issues">Issue Tracker</a> <br />
           <a class="sidebar-link external-link" target="_blank" href="https://github.com/apache/incubator-age">Github</a> <br />
         </p>
@@ -296,7 +295,225 @@ $$) as (a agtype);
 
           </div>
         </div>
+
+         <!-- 
+          *
+          * CONTRIBUTION 
+          *
+        -->
+        <div class="main-item" id="main-contribute">
+          <div class="title">
+            How to contribute
+          </div>
+          <div class="main-body">
+            There are multiple ways you can contribute to the project.And help is always welcome! All details can be 
+            found on the contributing page. Keep reading for a quick overview!
+  
+            <div class="subtitle">
+              Becoming a Commiter
+            </div>
+            If you are interested in the project and looking for ways to help, consult the list of tasks in JIRA, or ask the mailing list.
+  
+  
+            <div class="subtitle">
+              Contributing by Helping Other Users
+            </div>
+            A great way to contribute to AGE is to help answer user questions on the TODO_LINK:mailing list or on TODO_LINK:StackOverflow. 
+            There are always many new AGE users; taking a few minutes to help answer a question is a very valuable community service.
+            <br>
+            Contributors should subscribe to this list and follow it to keep up to date on what's happening in AGE. Answering 
+            questions is an excellent and visible way to help the community, which also demonstrates your expertise.
+            <br>
+            See the Mailing Lists guide for guidelines about how to effectively participate in discussions on the mailing list, 
+            as well as forums like StackOverflow.
+  
+  
+            <div class="subtitle">
+              Contributing by Reviewing Changes
+            </div>
+            Changes to AGE source code are proposed, reviewed, and committed via Github pull requests (described in Instruction Link). 
+            Anyone can view and comment on active changes here. Reviewing others' changes is a good way to learn how the change process works 
+            and gain exposure to activity in various parts of the code. You can help by reviewing the changes and asking questions 
+            or pointing out issues as simple as typos or small issues of style.
+  
+  
+            <div class="subtitle">
+              Contributing Documentation Changes
+            </div>
+            To propose a change to release documentation (that is, docs that appear under TODO_LINK:https://AGE.apache.org/instruction/), 
+            edit the Markdown source files in AGE's <span class="inline-code">docs/</span> directory on GitHub, whose README file shows how to 
+            build the documentation locally to test your changes. The process to propose a doc change is otherwise the same as the 
+            process for proposing code changes below.
+  
+  
+            <div class="subtitle">
+              Contributing Bug Reports
+            </div>
+            Ideally, bug reports are accompanied by a proposed code change to fix the bug. This isn't always possible, as those who discover a 
+            bug may not have the experience to fix it. A bug may be reported by creating a JIRA issue but without creating a pull request.
+            <br>
+            Bug reports are only useful, however, if they include enough information to understand, isolate and ideally reproduce the bug. 
+            Simply encountering an error does not mean a bug should be reported; search JIRA and inquire on the AGE user / dev mailing 
+            lists first. Unreproducible bugs, or simple error reports, may be closed.
+            <br>
+            The more context the reporter can give about a bug, the better, such as: how the bug was introduced, by which 
+            commit, etc. It assists the committers in the decision process on how far the bug fix should be backported, 
+            when the pull request is merged. The pull request to fix the bug should narrow down the problem to the root cause.
+            <br>
+            Data correctness/data loss bugs are very serious. Make sure the corresponding bug report JIRA issue is labeled 
+            as correctness or data-loss. Please send an email to <a href="mailto:dev@age.apache.org">dev@age.apache.org</a> after submitting 
+            the bug report, to quickly draw attention to the issue.
+            <br>
+            Performance issues are classified as bugs. The pull request to fix a performance bug must provide a benchmark 
+            to prove the problem is indeed fixed.
+
+  
+            <div class="subtitle">
+              Contributing to JIRA Maintenance
+            </div>
+            Most contributors can directly resolve JIRA issues. Use judgment in determining whether you are confident the issue should be 
+            resolved (although changes can be easily undone).
+            <br> 
+            When resolving JIRA tickets, please observe the following conventions:
+            <ul>
+              <li>
+                Resolve as Fixed if there's a release or code commit that resolved the issue.
+                <ul>
+                  <li>
+                    Set Fix Version(s), if and only if the resolution is Fixeds
+                  </li>
+                  <li>
+                    Set Assignee to the person who contributed the most to its resolution, usually the person who opened the PR that resolved the issue.
+                  </li>
+                </ul>
+              </li>
+              <li>
+                For issues that can't be reproduced against master as reported, resolve as Cannot Reproduce.
+              </li>
+              <li>
+                If the issue is the same as or a subset of another issue, resolved as Duplicate
+                <ul>
+                  <li>
+                    Mark the issue that has less activity or discussion as the duplicate.
+                  </li>
+                  <li>
+                    Link it to the JIRA ticket it duplicates.
+                  </li>
+                </ul>
+              </li>
+              <li>
+                If the issue seems clearly obsolete and applies to issues or components that have changed radically since it was opened, resolve as Not a Problem
+              </li>
+              <li>
+                If the issue doesn't make sense or is not actionable resolve as Invalid.
+              </li>
+              <li>
+                If it's a coherent issue, but there is a clear indication that there is not support or interest in acting on it, then resolve as Won't Fix.
+              </li>
+            </ul>
+            <br>
+            <span class="emph">Searching JIRA</span>
+            How to search JIRA for existing issues:
+            <ol>
+              <li><span class="emph">Basic:</span>
+                <ol>
+                  <li>Visit <a href="https://issues.apache.org/jira/projects/AGE/issues">AGE JIRA</a></li>
+                  <li>Type query into search box in top right (beware this will return results from all projects)</li>
+                </ol>
+              </li>
+              <li>
+                <span class="emph">Advanced: </span>
+                <ol>
+                  <li>Visit <a href="https://issues.apache.org/jira/issues/?jql=(project%3DAGE)%20and%20text%20~%20%22%22">AGE JIRA Advanced Search</a></li>
+                  <li>Replace the empty quotes with quoted text (such as "cypher")</li>
+                </ol>
+              </li>
+              <li>
+                <span class="emph">Search Now:</span>
+                <ol>
+                  <li>Use the search box below</li>
+                  <li><input class="search" id="jira-search" placeholder="search term"><button class="search" id="jira-submit" onclick="handleJiraSearch()">Search</button></li>
+                </ol>
+                
+              </li>
+            </ol> 
+            If a logically similar issue already exists, then contribute to the discussion on the existing JIRA ticket and pull request, instead of creating a new ticket and PR.
+          </div>
+        </div>
+
+        <!-- 
+          *
+          * COMMUNITY 
+          *
+        -->
+        <div class="main-item" id="main-mailinglists">
+          <div class="title">Mailing Lists</div>
+          <div class="main-body">
+            Get help using Apache AGE (Incubating) or contribute to the project on our mailing lists:
+
+            <ul>
+              <li>
+                Visit <a target="_blank" class="external-link" href="https://lists.apache.org/list.html?commits@age.apache.org">
+                  Commits</a> 
+                  or <a class="mail-link" href="mailto:commits-subscribe@age.apache.org">subscribe</a>
+                  for people following commits to the project.
+              </li>
+              <li>
+                Visit <a target="_blank" class="external-link" href="https://lists.apache.org/list.html?dev@age.apache.org">
+                  Developer</a> 
+                  or <a class="mail-link" href="mailto:dev-subscribe@age.apache.org">subscribe</a>
+                  for developers wanting to commit code to the project.
+              </li>
+              <li>
+                Visit <a target="_blank" class="external-link" href="https://lists.apache.org/list.html?users@age.apache.org">
+                  Users</a> 
+                  or <a class="mail-link" href="mailto:users-subscribe@age.apache.org">subscribe</a>
+                  for users wanting to learn more about the project.
+              </li>
+            </ul>
+          </div>
+        </div>
+
+        <div class="main-item" id="main-team">
+          <div class="title">Apache AGE Team Members</div>
+          <div class="main-body">
+            <div class="subtitle center">✪ Champions and Mentors ✪</div>
+            <table class="center">
+              <thead>
+                <tr><th scope="col">Name</th><th scope="col">Email</th></tr>
+              </thead>
+              <tbody>
+                <tr><td>Raphael Bircher</td>	<td>rbircher at apache dot org</td></tr>
+                <tr><td>Von Gosling</td>	<td>vongosling at apachedot org</td></tr>
+                <tr><td>Jim Jagielski</td>	<td>jim at apache dot org </td></tr>
+                <tr><td>Kevin Ratnasekera</td>	<td>kevin at agsft dot com</td></tr>
+              </tbody>
+            </table>
+            <div class="subtitle center">✰ Committers ✰</div>
+            <p class="center">AGE's active Committers are (sorted on lastname in alphabetical order):</p>
+            <table class="center">
+              <thead>
+                <tr><th scope="col">Name</th><th scope="col">Email</th></tr>
+              </thead>
+              <tbody>
+                <tr><td>Jasper Blues</td>	<td>jasper at liberation dash data dot com</td></tr>
+                <tr><td>John Gemignani</td>	<td>john dot gemignani at bitnine dot net</td></tr>
+                <tr><td>Josh Innis</td>	<td>josh dot innis at bitnine dot net</td></tr>
+                <tr><td>Mason Sharp</td>	<td>mason dot sharp at gmail dot com</td></tr>
+                <tr><td>Junseok Yang</td>	<td>jsyang at bitnine dot net</td></tr>
+              </tbody>
+            </table>
+
+
+          </div>
+        </div>
       </div>
+
+    </div>
+    <div class="footer">
+      <hr>
+      <img class="footer-img" src="assets/images/incubator_ring_logo.png"> <br>
+      <p class="center">Copyright © 2020 The Apache Software Foundation.Apache and the Apache feather logo are trademarks of The Apache Software Foundation</p>
     </div>
   </body>
 </html>