Merge pull request #9 from HotSushi/main

Remove docsite, make it into a different branch, update CONTRIBUTING.md
linkedin · Feb 22, 2024 · 8991d31 · 8991d31
2 parents 631e2ab + 365d0a1
commit 8991d31
Show file tree

Hide file tree

Showing 40 changed files with 16 additions and 15,925 deletions.
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
@@ -1,14 +1,14 @@
 <html>
   <div align="center">
-    <img src="docs/static/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
+    <img src="docs/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
   </div>
 </html>
 
 ## Control Plane for Tables
 
 Following figure shows how OpenHouse control plane fits into a broader open source data lakehouse deployment.
 
-![High Level Overview](docs/static/images/openhouse-controlplane.jpeg)
+![High Level Overview](docs/images/openhouse-controlplane.jpeg)
 
 ### Catalog Service
 
@@ -109,7 +109,7 @@ Trino and Flink engines follow a similar pattern of integration with OpenHouse a
 
 ## Deployed System Architecture
 
-![Example Deployed System Architecture](docs/static/images/openhouse-deployed-architecture.jpeg)
+![Example Deployed System Architecture](docs/images/openhouse-deployed-architecture.jpeg)
 
 The figure above shows system components of OpenHouse deployed at LinkedIn. Each component is numbered and its purpose
 is as follows:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -56,7 +56,15 @@ maintainers) who will help through the feature delivery, define an execution pla
 PR into smaller PRs. Please expect more scrutiny if there are API changes. For any API changes, the [specs](docs/specs) need
 to be updated, see instructions [here](docs/specs/README.md).
 
-[3] Documentation (#docs): Kinds of documentation include README, API documentation, etc.
+[3] Documentation (#docs): Kinds of documentation include README, API documentation, Documentation website etc.
+
+#### Documentation Website Contribution
+
+Documentation website is hosted on a different branch [docsite](https://github.com/linkedin/openhouse/tree/docsite). Instructions to build the documentation site
+can be found at the root [README.md](https://github.com/linkedin/openhouse/blob/docsite/README.md). 
+
+Create a PR against the branch `docsite` for your documentation website changes. When changes are merged into `docsite`, a GitHub Action will automatically publish static HTML files to the `gh_pages` branch. These files will then be deployed to the website. Note: `gh_pages` is a gh-action built branch, PR shouldn't be raised against it.
+
 
 ## Code of Conduct
 

diff --git a/DEPLOY.md b/DEPLOY.md
@@ -1,6 +1,6 @@
 <html>
   <div align="center">
-    <img src="docs/static/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
+    <img src="docs/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
   </div>
 </html>
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <html>
   <div align="center">
-    <img src="docs/static/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
+    <img src="docs/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
   </div>
   <h3 align="center">
     Control Plane for Tables in Open Data Lakehouses
@@ -20,7 +20,7 @@ data services.
 
 <html>
   <div align="center">
-    <img src="docs/static/images/openhouse-controlplane.jpeg">
+    <img src="docs/images/openhouse-controlplane.jpeg">
   </div>
 </html>
 

diff --git a/SETUP.md b/SETUP.md
@@ -1,6 +1,6 @@
 <html>
   <div align="center">
-    <img src="docs/static/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
+    <img src="docs/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
   </div>
 </html>
 

diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/babel.config.js b/docs/babel.config.js
diff --git a/docs/blog/2023-07-19-introduction-oh.mdx b/docs/blog/2023-07-19-introduction-oh.mdx
diff --git a/docs/development/CONTRIBUTING.md b/docs/development/CONTRIBUTING.md
diff --git a/docs/development/client-code-generation.md b/docs/development/client-code-generation.md
diff --git a/docs/development/container-images.md b/docs/development/container-images.md
diff --git a/docs/development/ide-setup-for-shadow-jars.gif b/docs/development/ide-setup-for-shadow-jars.gif