Initial V1 doc (#393)

* add index md

* Adds a .nojekyll file for docs builds

* Init version of doc

* Add more docs

* add deploy script

* Update doc

* new fix

* Initial V1 for Amundsen doc

* Add doc how to push doc

.gitignore

@@ -4,3 +4,5 @@ example/docker/es_data*
 .local/
 
 .idea/
+venv/
+site/

README.md

 <img
-  src="docs/img/logos/amundsen_logo_on_light.svg"
+  src="https://raw.githubusercontent.com/lyft/amundsen/master/docs/img/logos/amundsen_logo_on_light.svg?sanitize=true"
   alt="Amundsen"
   width="500"
 />
@@ -12,6 +12,7 @@
 Amundsen is a metadata driven application for improving the productivity of data analysts, data scientists and engineers when interacting with data. It does that today by indexing data resources (tables, dashboards, streams, etc.) and powering a page-rank style search based on usage patterns (e.g. highly queried tables show up earlier than less queried tables). Think of it as Google search for data. The project is named after Norwegian explorer [Roald Amundsen](https://en.wikipedia.org/wiki/Roald_Amundsen), the first person to discover the South Pole.
 
 It includes three microservices, one data ingestion library and one common library.
+
 - [amundsenfrontendlibrary](https://github.com/lyft/amundsenfrontendlibrary#amundsen-frontend-service): Frontend service which is a Flask application with a React frontend.
 - [amundsensearchlibrary](https://github.com/lyft/amundsensearchlibrary#amundsen-search-service): Search service, which leverages Elasticsearch for search capabilities, is used to power frontend metadata searching.
 - [amundsenmetadatalibrary](https://github.com/lyft/amundsenmetadatalibrary#amundsen-metadata-service): Metadata service, which leverages Neo4j or Apache Atlas as the persistent layer, to provide various metadata.
@@ -32,23 +33,23 @@ Please note that the mock images only served as demonstration purpose.
 
 - **Landing Page**: The landing page for Amundsen including 1. search bars; 2. popular used tables;
 
-    ![](docs/img/landing_page.png)
+    ![](https://raw.githubusercontent.com/lyft/amundsen/master/docs/img/landing_page.png)
 
 - **Search Preview**: See inline search results as you type
 
-    ![](docs/img/search_preview.png)
+    ![](https://raw.githubusercontent.com/lyft/amundsen/master/docs/img/search_preview.png)
 
 - **Table Detail Page**: Visualization of a Hive / Redshift table
 
-    ![](docs/img/table_detail_page_with_badges.png)
+    ![](https://raw.githubusercontent.com/lyft/amundsen/master/docs/img/table_detail_page_with_badges.png)
 
 - **Column detail**: Visualization of columns of a Hive / Redshift table which includes an optional stats display
 
-    ![](docs/img/column_details.png)
+    ![](https://raw.githubusercontent.com/lyft/amundsen/master/docs/img/column_details.png)
 
 - **Data Preview Page**: Visualization of table data preview which could integrate with [Apache Superset](https://github.com/apache/incubator-superset) or other Data Visualization Tools.
 
-    ![](docs/img/data_preview.png)
+    ![](https://raw.githubusercontent.com/lyft/amundsen/master/docs/img/data_preview.png)
 
 ## Get Involved in the Community
 
@@ -61,7 +62,7 @@ Please visit the Amundsen installation documentation for a [quick start](https:/
 
 ## Architecture Overview
 
-Please visit [Architecture](docs/architecture.md#architecture) for Amundsen architecture overview.
+Please visit [Architecture](https://github.com/lyft/amundsen/blob/master/docs/architecture.md#architecture) for Amundsen architecture overview.
 
 ## Supported connectors
 Amundsen supports two kinds of "nodes" in its graph today:
@@ -78,11 +79,11 @@ The databases we see most frequently used in the community are:
 
 ## Installation
 
-Please visit [Installation guideline](docs/installation.md) on how to install Amundsen.
+Please visit [Installation guideline](https://github.com/lyft/amundsen/blob/master/docs/installation.md) on how to install Amundsen.
 
 ## Roadmap
 
-Please visit [Roadmap](docs/roadmap.md#amundsen-roadmap) if you are interested in Amundsen upcoming roadmap items.
+Please visit [Roadmap](https://github.com/lyft/amundsen/blob/master/docs/roadmap.md#amundsen-roadmap) if you are interested in Amundsen upcoming roadmap items.
 
 ## Blog Posts and Interviews
 

deploy_website.sh

+set -ex
+
+#REPO="git@github.com:lyft/amundsen.git"
+#DIR=temp-clone
+# We use https://www.mkdocs.org/user-guide/deploying-your-docs/ to build/deploy docs
+# Currently the doc is built/deployed manually. We should first build and deploy locally and verify it.
+# Here are some basic steps:
+# 1. virtualenv env
+# 2. source venv/bin/activate
+# 3. pip3 install -r requirements.txt
+# 4. brew install mkdocs
+# 5. mkdocs serve # build locally and serve it in localhost:8000
+# 6. mkdocs gh-deploy # deploy to gh page
+
+# Delete any existing temporary website clone.
+#rm -rf $DIR
+
+# Clone the current repo into temp folder.
+#git clone $REPO $DIR
+
+# Move working directory into temp folder.
+#cd $DIR
+
+# Build the site and push the new files up to GitHub.
+mkdocs gh-deploy
+git checkout gh-pages
+git push
+
+# Delete our temp folder.
+#cd ..
+#rm -rf $DIR

docs/common

+../amundsencommon
\ No newline at end of file

docs/css/app.css

+@import "theme.css";
+
+/* Splits a long line descriptions in tables in to multiple lines */
+.wy-table-responsive table td, .wy-table-responsive table th {
+  white-space: normal !important;
+}
+
+/* align multi line csv table columns */
+table.docutils div.line-block {
+    margin-left: 0;
+}

docs/databuilder

+../amundsendatabuilder
\ No newline at end of file

docs/frontend

+../amundsenfrontendlibrary
\ No newline at end of file

docs/index.md

+../README.md
\ No newline at end of file

docs/k8s_install.md

+../amundsen-kube-helm/README.md
\ No newline at end of file

docs/metadata

+../amundsenmetadatalibrary
\ No newline at end of file

docs/search

+../amundsensearchlibrary
\ No newline at end of file

mkdocs.yml

+site_name: Amundsen
+repo_name: Amundsen
+repo_url: https://github.com/lyft/Amundsen
+site_description: "Amundsen is a metadata driven application for improving the productivity of data analysts, data scientists and engineers when interacting with data."
+site_author: Lyft, Inc.
+site_url: https://lyft.github.io/amundsen/
+remote_branch: gh-pages
+
+copyright: 'Copyright © 2020 Lyft, Inc.'
+
+theme:
+  name: 'material'
+  logo: img/logos/amundsen_mark_orange.svg
+  favicon: 'img/logos/amundsen_mark_orange.svg'
+  palette:
+    primary: 'blue'
+    accent: 'pink'
+  feature:
+    tabs: true
+
+-extra_css:
+  - 'css/app.css'
+
+
+markdown_extensions:
+  - admonition
+  - smarty
+  - codehilite:
+      guess_lang: false
+      linenums: True
+  - footnotes
+  - meta
+  - toc:
+      permalink: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - tables
+
+
+extra:
+  # type is the name of the FontAwesome icon without the fa- prefix.
+  social:
+    - type: globe
+      link: https://lyft.github.io/
+    - type: github-alt
+      link: https://github.com/lyft
+    - type: twitter
+      link: https://twitter.com/lyfteng
+    - type: linkedin
+      link: https://www.linkedin.com/company/lyft/
+
+nav:
+  - 'Overview': index.md
+  - 'Architecture': architecture.md
+  - 'Developer Guide':
+    - 'Overview': developer_guide.md
+  - 'User Guide':
+    - 'Quick Start': 'installation.md'
+    - 'Deployment':
+      - 'Authentication': 'authentication/oidc.md'
+      - 'AWS ECS Installation': 'installation-aws-ecs/aws-ecs-deployment.md'
+      - 'K8S Installation': 'k8s_install.md'
+  - 'Components':
+    - 'Frontend':
+        - 'Overview': 'frontend/README.md'
+        - 'Configuration':
+          - 'Application Config': 'frontend/docs/application_config.md'
+          - 'React Configuration': 'frontend/docs/configuration.md'
+          - 'Flask Configuration': 'frontend/docs/flask_config.md'
+          - 'Preview Client Setup': 'frontend/docs/examples/superset_preview_client.md'
+        - 'FE Developer Guide': 'frontend/docs/developer_guide.md'
+        - 'FE Installation Guide': 'frontend/docs/installation.md'
+        - 'Recommended Practices': 'frontend/docs/recommended_practices.md'
+        - 'Code Of Conduct': 'frontend/CODE_OF_CONDUCT.md'
+    - 'Search':
+      - 'Overview': 'search/README.md'
+      - 'Proxy':
+        - 'Atlas Backend': 'search/docs/atlas-search.md'
+      - 'Code Of Conduct': 'search/CODE_OF_CONDUCT.md'
+    - 'Metadata':
+      - 'Overview': 'metadata/README.md'
+      - 'Configuration':
+        - 'Overview': 'metadata/docs/configurations.md'
+      - 'Metadata API Structure': 'metadata/docs/structure.md'
+      - 'Proxy':
+        - 'Atlas Backend':
+            - 'Overview': 'metadata/docs/proxy/atlas_proxy.md'
+            - 'Popular Table': 'metadata/docs/proxy/atlas/popular_tables.md'
+        - 'Gremlin Backend': 'metadata/docs/proxy/gremlin.md'
+        - 'Neptune Backend': 'metadata/docs/proxy/neptune.md'
+      - 'Code Of Conduct': 'metadata/CODE_OF_CONDUCT.md'
+    - 'Databuilder':
+      - 'Overview': 'databuilder/README.md'
+      - 'Models': 'databuilder/docs/models.md'
+      - 'Code Of Conduct': 'databuilder/CODE_OF_CONDUCT.md'
+    - 'Common':
+      - 'Overview': 'common/README.md'
+      - 'Code Of Conduct': 'common/CODE_OF_CONDUCT.md'
+  - 'FAQ': faq.md
+  - 'Roadmap': roadmap.md

requirements.txt

+mkdocs==1.1
+mkdocs-material==4.6.3
+mkdocs-redirects==1.0.0