docs: update docs for public release (#174)

README.md

@@ -1,6 +1,11 @@
 <br />
 <div align="center">
     <h1 align="center">Vertex Pipelines Deployer</h1>
+    <p align="center">
+        <a href="https://www.artefact.com/">
+        <img src="docs/assets/Artefact-AI-is-about-People-logo-1200x424.png" style="max-width:50%;height:auto;background-color:#111146;" alt="Artefact Logo"/>
+        </a>
+    </p>
     <h3 align="center">Deploy Vertex Pipelines within minutes</h3>
         <p align="center">
         This tool is a wrapper around <a href="https://www.kubeflow.org/docs/components/pipelines/v2/hello-world/">kfp</a> and <a href="https://cloud.google.com/python/docs/reference/aiplatform/latest">google-cloud-aiplatform</a> that allows you to check, compile, upload, run, and schedule Vertex Pipelines in a standardized manner.
@@ -57,9 +62,9 @@
 
 [Full CLI documentation](docs/CLI_REFERENCE.md)
 
-<!-- --8<-- [start:why] -->
-## ❓ Why this tool?
 
+## ❓ Why this tool?
+<!-- --8<-- [start:why] -->
 
 Three use cases:
 
@@ -86,6 +91,11 @@ Two main commands:
 
 ## 📦 Installation
 <!-- --8<-- [start:installation] -->
+### From PyPI
+
+```bash
+pip install vertex-deployer
+```
 
 ### From git repo
 
@@ -105,32 +115,6 @@ git clone [email protected]:artefactory/vertex-pipelines-deployer.git
 poetry install
 cd example
 ```
-
-### From Artifact Registry (not available in PyPI yet)
-
-The package is available on a public Google Artifact Registry repo. You need to specify a
-[pip extra index url](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-extra-index-url) to install it.
-
-Install latest version:
-```bash
-pip install --extra-index-url https://europe-west1-python.pkg.dev/data-sandbox-fr/artefactory/simple vertex-deployer
-```
-
-!!! tip "Add to requirements"
-    You can add the extra index URL to your `requirements.in` or `requirements.txt` file.
-    ```txt title="requirements.txt"
-    --extra-index-url https://europe-west1-python.pkg.dev/data-sandbox-fr/artefactory/simple
-
-    vertex-deployer==0.3.3
-    ```
-
-??? info "About extra index URL"
-    You can add the extra index URL to your `pip.conf` file to avoid having to specify it every time.
-
-List available versions:
-```bash
-pip index versions --extra-index-url https://europe-west1-python.pkg.dev/data-sandbox-fr/artefactory/simple vertex-deployer
-```
 <!-- --8<-- [end:installation] -->
 
 ## 🚀 Usage

docs/index.md

@@ -2,6 +2,11 @@
 <br />
 <div align="center">
     <!-- <h1 align="center">Vertex Pipelines Deployer</h1> -->
+    <p align="center">
+        <a href="https://www.artefact.com/">
+        <img src="assets/Artefact-AI-is-about-People-logo-1200x424.png" style="max-width:50%;height:auto;background-color:#111146;" alt="Artefact Logo"/>
+        </a>
+    </p>
     <h3 align="center">Deploy Vertex Pipelines within minutes</h3>
         <p align="center">
         This tool is a wrapper around <a href="https://www.kubeflow.org/docs/components/pipelines/v2/hello-world/">kfp</a> and <a href="https://cloud.google.com/python/docs/reference/aiplatform/latest">google-cloud-aiplatform</a> that allows you to check, compile, upload, run and schedule Vertex Pipelines in a standardized manner.
@@ -27,4 +32,21 @@
     You can contact code owners or **[submit a new issue](https://github.com/artefactory/vertex-pipelines-deployer/issues/new/choose)** if you want to help.
 
 
+## Why this tool?
+
 --8<-- "README.md:why"
+
+
+## Installation
+
+--8<-- "README.md:installation"
+
+
+## Basic Usage
+
+Please refer to the [Basic Usage](usage.md) page for more information.
+
+
+## License
+
+This project is licensed under the terms of the Apache 2.0.

docs/stylesheets/extra.css

@@ -0,0 +1,4 @@
+:root {
+    --md-primary-fg-color:               #111146;
+    --md-accent-fg-color:                #e61f68;
+}

mkdocs.yml

@@ -4,20 +4,22 @@ repo_url: https://github.com/artefactory/vertex-pipelines-deployer
 
 theme:
   name: material
+  logo: assets/Artefact-AI-is-about-People-logo-1200x424.png
+  favicon: assets/artefact-favicon.png
   palette:
   - media: '(prefers-color-scheme: light)'
     scheme: default
-    primary: teal
-    accent: amber
+    primary: custom
+    accent: pink
     toggle:
-      icon: material/lightbulb
+      icon: material/weather-night
       name: Switch to dark mode
   - media: '(prefers-color-scheme: dark)'
     scheme: slate
-    primary: teal
-    accent: amber
+    primary: cyan
+    accent: pink
     toggle:
-      icon: material/lightbulb-outline
+      icon: material/weather-sunny
       name: Switch to light mode
   features:
   - search.suggest
@@ -29,12 +31,19 @@ theme:
 
 plugins:
   - search
-  - techdocs-core
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+extra_css:
+  - stylesheets/extra.css
 
 nav:
-  - Get Started:
-    - Welcome: index.md
-    - Installation: install.md
+  - Vertex Deployer:
+    - Get Started: index.md
     - Prerequisites & Setup: setup.md
     - Folder Structure: folder_structure.md
     - Basic Usage: usage.md

pyproject.toml

@@ -40,10 +40,9 @@ ruff = "^0.3"
 pytest-cov = "^4.1"
 codespell = "^2.2"
 
-
 [tool.poetry.group.docs.dependencies]
 mkdocs = "^1.5"
-mkdocs-techdocs-core = "^1.2"
+mkdocs-material = {extras = ["pygments"], version = "^9.5.17"}
 
 [tool.poetry.extras]
 profiling = ["pyinstrument"]