Updated technical resources and onboarding links

BuildingSync · Dec 17, 2022 · 2619083 · 2619083
1 parent 6c82bbb
commit 2619083
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 23 deletions.
diff --git a/bsyncviewer/templates/adopters.html b/bsyncviewer/templates/adopters.html
@@ -13,19 +13,19 @@
           <div class="serv-row text-center">
             <div class="col-md-4">
               <div class="serv-item">
-                <a href="https://www.erdc.usace.army.mil/Locations/CERL/" target="_blank" rel="noopener"><img class="collab-image-sf" src="{% static 'images/cerl.png' %}" alt="CERL logo"></a>
+                <a href="https://www.lbl.gov/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/berkley_lab_logo.svg' %}" alt="LBL logo"></a>
               </div>
             </div>
 
             <div class="col-md-4">
               <div class="serv-item">
-                <a href="https://doee.dc.gov/" target="_blank" rel="noopener"><img class="collab-image-sf" src="{% static 'images/doee.jpg' %}" alt="DOEE logo"></a>
+                <a href="https://buildee.com/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/buildee.png' %}" alt="Buildee logo"></a>
               </div>
             </div>
 
             <div class="col-md-4">
               <div class="serv-item">
-                <a href="https://openstudio.net/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/openstudio.png' %}" alt="OpenStudio logo"></a>
+                <a href="https://www.erdc.usace.army.mil/Locations/CERL/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/cerl.png' %}" alt="CERL logo"></a>
               </div>
             </div>
           </div>
@@ -35,35 +35,37 @@
           <div class="serv-row text-center">
             <div class="col-md-4">
               <div class="serv-item">
-                <a href="https://www.pnnl.gov/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/pnnl.png' %}" alt="PNNL logo"></a>
+                <a href="https://doee.dc.gov/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/doee.jpg' %}" alt="DOEE logo"></a>
               </div>
             </div>
 
             <div class="col-md-4">
               <div class="serv-item">
-                <a href="https://psdconsulting.com/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/psd.png' %}" alt="PSD logo"></a>
+                <a href="https://openstudio.net/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/openstudio.png' %}" alt="OpenStudio logo"></a>
               </div>
             </div>
 
             <div class="col-md-4">
-              <div class="serv-item-sf">
-                <a href="https://sfenvironment.org/" target="_blank" rel="noopener"><img class="collab-image-sf" src="{% static 'images/sf_environment.png' %}" alt="SF Environment logo"></a>
+              <div class="serv-item">
+                <a href="https://www.pnnl.gov/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/pnnl.png' %}" alt="PNNL logo"></a>
               </div>
             </div>
           </div>
         </div>
 
         <div class="row">
           <div class="serv-row text-center">
-            <div class="col-md-4"></div>
-
             <div class="col-md-4">
               <div class="serv-item">
-                <a href="https://buildee.com/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/buildee.png' %}" alt="Buildee logo"></a>
+                <a href="https://psdconsulting.com/" target="_blank" rel="noopener"><img class="collab-image" src="{% static 'images/psd.png' %}" alt="PSD logo"></a>
               </div>
             </div>
 
-            <div class="col-md-4"></div>
+            <div class="col-md-4">
+              <div class="serv-item-sf">
+                <a href="https://sfenvironment.org/" target="_blank" rel="noopener"><img class="collab-image-sf" src="{% static 'images/sf_environment.png' %}" alt="SF Environment logo"></a>
+              </div>
+            </div>
           </div>
         </div>
       </div>

diff --git a/bsyncviewer/templates/auditors.html b/bsyncviewer/templates/auditors.html
@@ -65,7 +65,7 @@ <h3 style="padding-top: 2em">Documents</h3>
     <hr>
     <section id="about" class="hero">
       <div class="row" style="padding-bottom: 5em">
-        <a href="{% static 'documents/BuildingSync-on-boarding.pdf' %}" target="_blank">
+        <a href="{% url 'onboarding' %}">
           <div class="hero-item col-lg-6 text-center">
             <span class="icon-documents"></span>
             <div class="hero-item-content">

diff --git a/bsyncviewer/templates/onboarding.html b/bsyncviewer/templates/onboarding.html
@@ -11,6 +11,9 @@
       padding-top: 20px;
       padding-bottom: 20px;
     }
+    button.pdf {
+      padding: 0 5px;
+    }
     ul {
       font-size: 18px;
       list-style: disc;
@@ -26,7 +29,24 @@
   </style>
 
   <div class="container bsync-main">
+    <div style="text-align: right">
+      <button class="pdf"><a href="{% static 'documents/BuildingSync-on-boarding.pdf' %}" target="_blank">PDF version</a></button>
+    </div>
     {% include "onboarding_content.html" %}
   </div>
 
+  <script>
+    const addTableClass = () => {
+      $('table').addClass('table');
+    }
+    const defer = (fn) => {
+      if (window.jQuery) {
+        fn();
+      } else {
+        setTimeout(() => { defer(fn) }, 50);
+      }
+    };
+    defer(addTableClass);
+  </script>
+
 {% endblock content %}
diff --git a/bsyncviewer/templates/practitioners.html b/bsyncviewer/templates/practitioners.html
@@ -61,13 +61,12 @@ <h3 style="padding-top: 2em">Documents</h3>
     <hr>
     <section id="about" class="hero">
       <div class="row" style="padding-bottom: 5em">
-        <a href="{% static 'documents/BuildingSync-on-boarding.pdf' %}" target="_blank">
+        <a href="{% url 'onboarding' %}">
           <div class="hero-item col-lg-6 text-center">
             <span class="icon-documents"></span>
             <div class="hero-item-content">
               <h5>Onboarding Guide</h5>
               <p class="mb-2">Find out how to get started with BuildingSync.</p>
-
             </div>
           </div>
         </a>

diff --git a/bsyncviewer/templates/technical_resources.html b/bsyncviewer/templates/technical_resources.html
@@ -8,23 +8,21 @@
 
   <div class="container bsync-main">
 
-    <h3>Guides</h3>
+    <h3>Getting Started / Helpful Guides</h3>
     <div class="list">
       <ul>
-        <li><strong>Energy Auditing with BuildingSync</strong>: an interactive introduction to what BuildingSync is and how it relates to buildings, building systems, and energy audit reporting.
+        <li><strong><a href="https://github.com/BuildingSync/schema/tree/develop-v2/docs/notebooks/bsync_examples" target="_blank" rel="noopener">Energy Auditing with BuildingSync</a></strong>: an interactive introduction to what BuildingSync is and how it relates to buildings, building systems, and energy audit reporting.
           <ul>
-            <li><strong><a href="https://github.com/BuildingSync/schema/blob/develop-v2/docs/notebooks/bsync_examples/Small-Office-Level-1.md" target="_blank" rel="noopener">Small Office Level 1</a></strong></li>
-            <li><strong><a href="https://github.com/BuildingSync/schema/blob/develop-v2/docs/notebooks/bsync_examples/Small-Office-Level-2.md" target="_blank" rel="noopener">Small Office Level 2</a></strong></li>
-            <li><strong><a href="https://github.com/BuildingSync/schema/blob/develop-v2/docs/notebooks/bsync_examples/Primary-School-Levels1-2.md" target="_blank" rel="noopener">Primary School Levels 1-2</a></strong></li>
+            <li><strong><a href="https://github.com/BuildingSync/schema/blob/develop-v2/docs/notebooks/bsync_examples/Small-Office-Level-1.md" target="_blank" rel="noopener">Example Level 1 Energy Audit on a Prototype Small Office building</a></strong></li>
+            <li><strong><a href="https://github.com/BuildingSync/schema/blob/develop-v2/docs/notebooks/bsync_examples/Small-Office-Level-2.md" target="_blank" rel="noopener">Example Level 2 Energy Audit on a Prototype Small Office building</a></strong></li>
+            <li><strong><a href="https://github.com/BuildingSync/schema/blob/develop-v2/docs/notebooks/bsync_examples/Primary-School-Levels1-2.md" target="_blank" rel="noopener">Example Level 1 & 2 Energy Audit on a Prototype Primary School</a></strong></li>
           </ul>
         </li>
-        <li><a href="{% static 'documents/BuildingSync-on-boarding.pdf' %}" target="_blank"><strong>BuildingSync On-boarding Guide</strong></a>: a PDF documenting BuildingSync Use Cases, their implementation
-          and publication.
-        </li>
+        <li><a href="{% url 'onboarding' %}"><strong>BuildingSync Onboarding Guide</strong></a>: documents BuildingSync use cases, their implementation, and publication.</li>
       </ul>
     </div>
 
-    <h3>File Validation</h3>
+    <h3>Validation Methods and Tools</h3>
 
     <p class="larger">For validation of BuildingSync XML files, the XML file undergoes a two-step validation process.</p>
     <div class="list">
@@ -87,6 +85,26 @@ <h3>File Validation</h3>
       </ol>
     </div>
 
+    <h4>New Users</h4>
+    <p><em>"I have a BuildingSync file, but I do not know if it is valid and/or will work for my use case."</em> - Use the <a href="{% url 'validator' %}">Validator Tool</a> to validate the file against the BuildingSync schema and all published use cases</p>
+
+    <h4>Application Developer</h4>
+    <p><em>"I have an application that I want to build and I would like to validate the incoming BuildingSync schema automatically."</em> - Set up an automated validation workflow through the Validator API and/or a Python package</p>
+
+    <ul class="list">
+      <li>Use the <a href="https://github.com/BuildingSync/BuildingSync-website#validator" target="_blank" rel="noopener">Validator API</a> for validation against schema and use cases</li>
+      <li>Use the functions in the <em><a href="https://github.com/BuildingSync/TestSuite" target="_blank" rel="noopener">testsuite</a></em> <a href="https://pypi.org/project/testsuite/" target="_blank" rel="noopener">Python package</a> to create use case schematrons and validate against them</li>
+    </ul>
+
+    <h4>BuildingSync Developer</h4>
+    <p><em>"I want to update BuildingSync and I need to test examples"</em> - Use any XML&XSD editor to modify the BuildingSync schema; create and edit the BuildingSync XML instance and validate the XML files against the schema</p>
+
+    <p>Available third-party tools:</p>
+    <ul class="list">
+      <li><a href="https://code.visualstudio.com/" target="_blank" rel="noopener">VS Code</a> with <a href="https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml" target="_blank" rel="noopener">XML extension</a></li>
+      <li><a href="https://www.oxygenxml.com/" target="_blank" rel="noopener">Oxygen XML Editor</a> (need a purchased license), and other various web-based XML editors</li>
+    </ul>
+
     <h3 id="validation-against-schematron">Validation Against Schematron</h3>
     <p class="larger">Download the Schematron document
       <a