[docs] Added java.md to developer docs (#1348)

Other minor changes: - Added instructions to avoid double brace init in the sytle guide. - Tweaked learn_more.md to include additional podcast links. - Added several SVG icons under the assets directory and sprinkled them over a few pages.
linkedin · Nov 27, 2024 · ee20094 · ee20094
1 parent 348ce77
commit ee20094
Show file tree

Hide file tree

Showing 16 changed files with 724 additions and 44 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,34 +1,22 @@
 <html>
-    <h1 align="center">
-      Venice
-    </h1>
-    <h3 align="center">
-      Derived Data Platform for Planet-Scale Workloads<br/>
-    </h3>
+    <!-- We cannot use CSS anywhere in this page, because the GitHub main repo doesn't render it. CSS is fine within the other docs pages though. -->
     <div align="center">
-        <a href="https://blog.venicedb.org/stable-releases">
-          <img src="https://img.shields.io/docker/v/venicedb/venice-router?label=stable&color=green&logo=docker" alt="Stable Release">
-        </a>
-        <a href="https://github.com/linkedin/venice/actions?query=branch%3Amain">
-          <img src="https://img.shields.io/github/actions/workflow/status/linkedin/venice/VeniceCI-StaticAnalysisAndUnitTests.yml" alt="CI">
-        </a>
-        <a href="https://venicedb.org/">
-          <img src="https://img.shields.io/badge/docs-grey" alt="Docs">
-        </a>
-    </div>
-    <div align="center">
-        <a href="https://github.com/linkedin/venice">
-          <img src="https://img.shields.io/badge/github-%23121011.svg?logo=github&logoColor=white" alt="GitHub">
-        </a>
-        <a href="https://www.linkedin.com/company/venicedb/">
-          <img src="https://img.shields.io/badge/linkedin-%230077B5.svg?logo=linkedin&logoColor=white" alt="LinkedIn">
-        </a>
-        <a href="https://twitter.com/VeniceDataBase">
-          <img src="https://img.shields.io/badge/Twitter-%231DA1F2.svg?logo=Twitter&logoColor=white" alt="Twitter">
-        </a>
-        <a href="http://slack.venicedb.org">
-          <img src="https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=white" alt="Slack">
-        </a>
+        <img src="assets/style/venice_full_lion_logo.svg" width="50%" alt="Venice">
+        <h3>
+          Derived Data Platform for Planet-Scale Workloads<br/>
+        </h3>
+        <div>
+            <!-- N.B.: We've got to leave no spaces within the <a href> tag otherwise we get blue link underlines inbetween the icons on the GitHub repo's main page (though not in the Just The Docs website). -->
+            <a href="https://blog.venicedb.org/stable-releases"><img src="https://img.shields.io/docker/v/venicedb/venice-router?label=stable&color=green&logo=docker" alt="Stable Release"></a>
+            <a href="https://github.com/linkedin/venice/actions?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/linkedin/venice/VeniceCI-StaticAnalysisAndUnitTests.yml" alt="CI"></a>
+            <a href="https://venicedb.org/"><img src="https://img.shields.io/badge/docs-grey" alt="Docs"></a>
+        </div>
+        <div>
+            <a href="https://github.com/linkedin/venice"><img src="https://img.shields.io/badge/github-%23121011.svg?logo=github&logoColor=white" alt="GitHub"></a>
+            <a href="https://www.linkedin.com/company/venicedb/"><img src="https://img.shields.io/badge/linkedin-%230077B5.svg?logo=linkedin&logoColor=white" alt="LinkedIn"></a>
+            <a href="https://twitter.com/VeniceDataBase"><img src="https://img.shields.io/badge/Twitter-%231DA1F2.svg?logo=Twitter&logoColor=white" alt="Twitter"></a>
+            <a href="http://slack.venicedb.org"><img src="https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=white" alt="Slack"></a>
+        </div>
     </div>
 </html>
 
@@ -129,7 +117,7 @@ cost/performance tradeoff without needing to rewrite their applications.
 
 # Resources
 
-The Open Sourcing Venice [blog](https://engineering.linkedin.com/blog/2022/open-sourcing-venice--linkedin-s-derived-data-platform)
+The _Open Sourcing Venice_ [blog](https://engineering.linkedin.com/blog/2022/open-sourcing-venice--linkedin-s-derived-data-platform)
 and [conference talk](https://www.youtube.com/watch?v=pJeg4V3JgYo) are good starting points to get an overview of what
 use cases and scale can Venice support. For more Venice posts, talks and podcasts, see our [Learn More](./user_guide/learn_more.md)
 page.
@@ -141,15 +129,16 @@ features like creating a data store, batch push, incremental push, and single ge
 
 ## Community
 Feel free to engage with the community using our:
-- [Slack workspace](http://slack.venicedb.org)
+<!-- N.B.: The links are duplicated here between the icon and text, otherwise the blue link underline extends into the space, which does not look good. -->
+- [<img src="assets/icons/slack-icon.svg" width="15" />](http://slack.venicedb.org) [Slack workspace](http://slack.venicedb.org)
   - Archived and publicly searchable on [Linen](http://linen.venicedb.org)
-- [LinkedIn group](https://www.linkedin.com/groups/14129519/)
-- [GitHub issues](https://github.com/linkedin/venice/issues)
-- [Contributor's guide](./dev_guide/how_to/how_to.md)
-- [Contributor's agreement](./dev_guide/how_to/CONTRIBUTING.md)
+- [<img src="assets/icons/linkedin-icon.svg" width="15" />](https://www.linkedin.com/groups/14129519/) [LinkedIn group](https://www.linkedin.com/groups/14129519/)
+- [<img src="assets/icons/github-icon.svg" width="15" />](https://github.com/linkedin/venice/issues) [GitHub issues](https://github.com/linkedin/venice/issues)
+- [<img src="assets/icons/github-icon.svg" width="15" />](./dev_guide/how_to/how_to.md) [Contributor's guide](./dev_guide/how_to/how_to.md)
 
 Follow us to hear more about the progress of the Venice project and community:
-- [Official blog](https://blog.venicedb.org)
-- [LinkedIn page](https://www.linkedin.com/company/venicedb)
-- [Find us on X](https://x.com/VeniceDataBase)
-- [YouTube channel](https://youtube.com/@venicedb)
+- [<img src="assets/icons/hashnode-icon.svg" width="15" />](https://blog.venicedb.org) [Official blog](https://blog.venicedb.org)
+- [<img src="assets/icons/linkedin-icon.svg" width="15" />](https://www.linkedin.com/company/venicedb) [LinkedIn page](https://www.linkedin.com/company/venicedb)
+- [<img src="assets/icons/x-icon.svg" width="15" />](https://x.com/VeniceDataBase) [X page](https://x.com/VeniceDataBase)
+- [<img src="assets/icons/youtube-icon.svg" width="15" />](https://youtube.com/@venicedb) [YouTube channel](https://youtube.com/@venicedb)
+
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,5 +1,7 @@
 title: Venice
 remote_theme: just-the-docs/just-the-docs
+favicon_ico: "/assets/style/favicon.ico"
+
 nav_external_links:
   - title: Javadoc
     url: ./javadoc/index.html

diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss
@@ -0,0 +1,8 @@
+// custom SCSS (or CSS) goes here
+
+.main-content {
+  h4 {
+    // h4 titles are a bit flimsy, so let's embolden them a bit!
+    font-weight: bold;
+  }
+}
diff --git a/docs/assets/icons/apple-podcasts-icon.svg b/docs/assets/icons/apple-podcasts-icon.svg
diff --git a/docs/assets/icons/github-icon.svg b/docs/assets/icons/github-icon.svg
diff --git a/docs/assets/icons/hashnode-icon.svg b/docs/assets/icons/hashnode-icon.svg
diff --git a/docs/assets/icons/linkedin-icon.svg b/docs/assets/icons/linkedin-icon.svg
diff --git a/docs/assets/icons/slack-icon.svg b/docs/assets/icons/slack-icon.svg
diff --git a/docs/assets/icons/spotify-icon.svg b/docs/assets/icons/spotify-icon.svg
diff --git a/docs/assets/icons/x-icon.svg b/docs/assets/icons/x-icon.svg
diff --git a/docs/assets/icons/youtube-icon.svg b/docs/assets/icons/youtube-icon.svg
diff --git a/docs/assets/style/favicon.ico b/docs/assets/style/favicon.ico