Merge pull request #6 from microsoft/governance-and-theme

Governance and theme

CODE_OF_CONDUCT.md

@@ -0,0 +1,14 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct][microsoft-open-source-code-of-conduct].
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct][microsoft-open-source-code-of-conduct]
+- [Microsoft Code of Conduct FAQ][microsoft-open-source-code-of-conduct-faq]
+- Contact [opencode@microsoft.com][microsoft-opencode-email-address] with questions or concerns
+
+<!-- Links -->
+[microsoft-open-source-code-of-conduct]: https://opensource.microsoft.com/codeofconduct/ "Microsoft Open Source Code of Conduct"
+[microsoft-open-source-code-of-conduct-faq]: https://opensource.microsoft.com/codeofconduct/faq/ "Microsoft Open Source Code of Conduct FAQ"
+[microsoft-opencode-email-address]: mailto:opencode@microsoft.com "opencode@microsoft.com"

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+## Contributing
+
+This project welcomes contributions and suggestions. Before you get started, you should read the [readme](README.md). 
+
+- 🤔 **CONSIDER** adding a unit test if your PR resolves an issue.
+- ✅ **DO** check open PR's to avoid duplicates.
+- ✅ **DO** keep pull requests small so they can be easily reviewed.
+- ✅ **DO** build locally before pushing.
+- ✅ **DO** make sure tests pass.
+- ✅ **DO** make sure any new changes are documented.
+- ✅ **DO** make sure not to introduce any compiler warnings.
+- ❌**AVOID** breaking the continuous integration build.
+- ❌**AVOID** making significant changes to the overall architecture.
+
+### Creating a Pull Request
+
+All pull requests should have an accompanying issue. Create one if there is not one matching your code. The code will be checked by continuous integration. Once this CI passes, the code will be reviewed, ideally approved, then merged.
+
+### CLA
+
+Open source contributions require you to agree to a standard Microsoft Contributor License Agreement (CLA) declaring that you grant us the rights to use your contribution. For details, visit [this page][microsoft-open-source-cla].
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+
+### Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct][microsoft-open-source-code-of-conduct]. For more information see the [Code of Conduct FAQ][microsoft-open-source-code-of-conduct-faq] or contact [opencode@microsoft.com][microsoft-opencode-email-address] with any additional questions or comments.
+
+<!-- Links -->
+[microsoft-open-source-cla]: https://cla.opensource.microsoft.com "Microsoft Open Source CLA"
+[microsoft-open-source-code-of-conduct]: https://opensource.microsoft.com/codeofconduct/ "Microsoft Open Source Code of Conduct"
+[microsoft-open-source-code-of-conduct-faq]: https://opensource.microsoft.com/codeofconduct/faq/ "Microsoft Open Source Code of Conduct FAQ"
+[microsoft-opencode-email-address]: mailto:opencode@microsoft.com "opencode@microsoft.com"

README.md

@@ -17,9 +17,10 @@ Your team should be familiar with the following:
 - Using a terminal (e.g., Bash, PowerShell, etc.)
 
 ### Hardware
+!!! Danger
+    Lobe is not currently supported on Apple computers with the M1 chip
+
 - A computer capable of running arbitrary code and on which you have administrative rights
-    !!! Danger
-        Lobe is not currently supported on Apple computers with the M1 chip
 - A stable internet connection (for setup and data download only)
 
 ### Software

SECURITY.md

@@ -0,0 +1,48 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft][microsoft-github], [Azure][azure-github], [DotNet][dotnet-github], [AspNet][aspnet-github], [Xamarin][xamarin-github], and [many more][microsoft-open-source].
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition][microsoft-security-bug] of a security vulnerability, please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](secure-microsoft-email).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page][microsoft-pgp-key].
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc][msrc].
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure][coordinated-vulnerability-disclosure].
+
+<!-- Links -->
+[microsoft-github]: https://github.com/Microsoft
+[azure-github]: https://github.com/Azure
+[dotnet-github]: https://github.com/dotnet
+[aspnet-github]: https://github.com/aspnet
+[xamarin-github]: https://github.com/xamarin
+[microsoft-open-source]: https://opensource.microsoft.com/
+[microsoft-security-bug]: https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)
+[secure-microsoft-email]: mailto:secure@microsoft.com
+[microsoft-pgp-key]: https://technet.microsoft.com/en-us/security/dn606155
+[msrc]: https://www.microsoft.com/msrc
+[coordinated-vulnerability-disclosure]: https://www.microsoft.com/en-us/msrc/cvd
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

goals/stylesheets/extra.css

@@ -1,10 +0,0 @@
-img {
-    display: block;
-    margin-left: auto;
-    margin-right: auto;
-    width: 50%;
-}
-
-figcaption {
-    max-width: 80% !important;
-}

mkdocs.yml

@@ -1,7 +1,70 @@
+# Project information
 site_name: Lobe Workshop
+site_url: https://microsoft.github.io/hack-workshop-lobe/
+site_author: Microsoft
+site_description: >-
+  Learn to use the Lobe.ai app to build your own image classification models!
+
+# Repository
+repo_name: microsoft/hack-workshop-lobe
+repo_url: https://github.com/microsoft/hack-workshop-lobe
+
+copyright: Copyright © Microsoft
+
+# Project structure
 docs_dir: goals
+
+# Customizations & theme
 extra_css:
-  - stylesheets/extra.css
+  - assets/stylesheets/extra.css
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/microsoft
+      name: Microsoft on GitHub
+    - icon: fontawesome/brands/linkedin
+      link: https://linkedin.com/in/Microsoft/
+      name: Microsoft on LinkedIn
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/Microsoft
+      name: Microsoft on Twitter
+  tos:
+    - link: https://privacy.microsoft.com/
+      name: Privacy
+    - link: https://www.microsoft.com/en-us/legal/terms-of-use
+      name: Terms of Use
+    - link: https://github.com/microsoft/hack-workshop-lobe/blob/main/LICENSE
+      name: License
+
+theme:
+  name: material
+  custom_dir: theme
+  features:
+    - navigation.indexes
+    - navigation.instant
+    - navigation.expand
+    - navigation.top
+    - toc.integrate
+  font: false
+  logo: assets/images/icon_garage_white.png
+  palette:
+    - media: "(prefers-color-scheme: light)" 
+      scheme: default
+      primary: teal
+      accent: teal
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)" 
+      scheme: slate
+      primary: teal
+      accent: teal
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+    
+# Extensions
 markdown_extensions:
   - admonition
   - attr_list
@@ -11,16 +74,12 @@ markdown_extensions:
   - smarty
   - toc:
       permalink: True
+
+# Plugins 
 plugins: 
   - include-markdown
-theme:
-  name: material
-  features:
-    - navigation.indexes
-    - navigation.instant
-    - navigation.expand
-    - navigation.top
-    - toc.integrate
+
+# Navigation
 nav:
     - Overview: 'index.md'
     - 'Goals':
@@ -28,4 +87,4 @@ nav:
       - '1-train.md'
       - '2-test.md'
       - '3-export.md'
-      - '4-run.md'
+      - '4-run.md'

theme/assets/stylesheets/extra.css

@@ -0,0 +1,83 @@
+@font-face {
+  font-family: "SegoeUI";
+  src: local("Segoe UI"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/normal/latest.woff2")
+      format("woff2"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/normal/latest.woff")
+      format("woff"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/normal/latest.ttf")
+      format("ttf");
+  font-weight: 400;
+}
+
+@font-face {
+  font-family: "SegoeUI";
+  src: local("Segoe UI"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/italic/latest.woff2")
+      format("woff2"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/italic/latest.woff")
+      format("woff"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/italic/latest.ttf")
+      format("ttf");
+  font-weight: 400;
+  font-style: italic;
+}
+
+@font-face {
+  font-family: "SegoeUI";
+  src: local("Segoe UI"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/Semilight/latest.woff2")
+      format("woff2"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/Semilight/latest.woff")
+      format("woff"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/Semilight/latest.ttf")
+      format("ttf");
+  font-weight: 300;
+}
+
+@font-face {
+  font-family: "SegoeUI";
+  src: local("Segoe UI"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/Bold/latest.woff2")
+      format("woff2"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/Bold/latest.woff")
+      format("woff"),
+    url("//c.s-microsoft.com/static/fonts/segoe-ui/west-european/Bold/latest.ttf")
+      format("ttf");
+  font-weight: 700;
+}
+
+:root {
+  --md-text-font-family: "Segoe UI", "SegoeUI","Helvetica Neue",Helvetica,Arial,sans-serif;
+}
+
+[data-md-color-primary=teal] {
+  --md-primary-fg-color: #004D40;
+  --md-primary-fg-color--light: #80CBC4;
+  --md-primary-fg-color--dark: #007a6c;
+  --md-primary-bg-color: #fff;
+  --md-primary-bg-color--light: hsla(0,0%,100%,0.7);
+}
+
+[data-md-color-scheme=slate] {
+  --md-typeset-a-color: var(--md-primary-fg-color--light);
+}
+
+img {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+  width: 50%;
+}
+
+figcaption {
+  max-width: 80% !important;
+}
+
+[class$="__repository"]{
+  overflow: unset;
+}
+
+[class $="tos__link"]{
+  padding-right: 0.25rem;
+}

theme/partials/footer.html

@@ -0,0 +1,92 @@
+{% import "partials/language.html" as lang with context %}
+
+<!-- Footer -->
+<footer class="md-footer">
+
+  <!-- Link to previous and/or next page -->
+  {% if page.previous_page or page.next_page %}
+    <nav
+      class="md-footer__inner md-grid"
+      aria-label="{{ lang.t('footer.title') }}"
+    >
+
+      <!-- Link to previous page -->
+      {% if page.previous_page %}
+        {% set direction = lang.t("footer.previous") %}
+        <a
+          href="{{ page.previous_page.url | url }}"
+          class="md-footer__link md-footer__link--prev"
+          aria-label="{{ direction }}: {{ page.previous_page.title | e }}"
+          rel="prev"
+        >
+          <div class="md-footer__button md-icon">
+            {% include ".icons/material/arrow-left.svg" %}
+          </div>
+          <div class="md-footer__title">
+            <div class="md-ellipsis">
+              <span class="md-footer__direction">
+                {{ direction }}
+              </span>
+              {{ page.previous_page.title }}
+            </div>
+          </div>
+        </a>
+      {% endif %}
+
+      <!-- Link to next page -->
+      {% if page.next_page %}
+        {% set direction = lang.t("footer.next") %}
+        <a
+          href="{{ page.next_page.url | url }}"
+          class="md-footer__link md-footer__link--next"
+          aria-label="{{ direction }}: {{ page.next_page.title | e }}"
+          rel="next"
+        >
+          <div class="md-footer__title">
+            <div class="md-ellipsis">
+              <span class="md-footer__direction">
+                {{ direction }}
+              </span>
+              {{ page.next_page.title }}
+            </div>
+          </div>
+          <div class="md-footer__button md-icon">
+            {% include ".icons/material/arrow-right.svg" %}
+          </div>
+        </a>
+      {% endif %}
+    </nav>
+  {% endif %}
+
+  <!-- Further information -->
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+
+      <!-- Theme information -->
+      {% if not config.extra.generator == false %}
+      <div class="md-footer-copyright">
+          Made with
+          <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+            Material for MkDocs
+          </a>
+      </div>
+      {% endif %}
+
+      <!-- Social links -->
+      {% include "partials/social.html" %}
+
+      <!-- Copyright and other links -->
+      <div class="md-footer-copyright">
+        {% if config.copyright %}
+        <span class="md-footer-copyright__highlight">
+          {{ config.copyright }}&nbsp;|&nbsp;&nbsp;
+        </span>
+        {% endif %}
+        
+        {% include "partials/tos.html" %}
+        
+        {{ extracopyright }}
+      </div>
+    </div>
+  </div>
+</footer>

theme/partials/tos.html

@@ -0,0 +1,19 @@
+<!-- See extra.tos to configure -->
+{% if config.extra.tos %}
+    {% for tos in config.extra.tos %}
+        {% set title = tos.name %}
+        {% if not title and "//" in tos.link %}
+            {% set _,url = tos.link.split("//") %}
+            {% set title = url.split("/")[0] %}
+        {% endif %}
+        <a
+            href="{{ tos.link }}"
+            target="_blank" rel="noopener"
+            title="{{ title | e }}"
+            class="md-footer-tos__link"
+        >
+            {{ title }}
+        </a>
+        &nbsp;
+    {% endfor %}
+{% endif %}