Skip to content

Commit

Permalink
task(mkdocs): deploy mkdocs (part 3)
Browse files Browse the repository at this point in the history
  • Loading branch information
svaponi committed Apr 19, 2024
1 parent 6b448cc commit add9cc1
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 44 deletions.
40 changes: 0 additions & 40 deletions docs/SETUP.md

This file was deleted.

29 changes: 29 additions & 0 deletions docs/gcloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Google Cloud Integration

This page contains information on how to configure the application to use resources on Google Cloud.
Use-cases:

- Install private dependencies published on [Artifact Registry](https://cloud.google.com/artifact-registry).
- Publish docker image on [Artifact Registry](https://cloud.google.com/artifact-registry).
- Deploy to [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine).
- Deploy to [Cloud Run](https://cloud.google.com/run).

## Install GCloud CLI

- Install it from the [GCloud Installation](https://cloud.google.com/sdk/docs/install) page.
- Run in terminal:

```shell
gcloud init
```

- You will be asked to sign via Google Sign On.
- Choose your project option from the menu.

## Install G-Cloud implementation of keyring in Poetry

1. Run in terminal:

```sh
poetry self add keyrings.google-artifactregistry-auth
```
2 changes: 0 additions & 2 deletions docs/INDEX.md → docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# fastapi-k8s

[FastAPI](https://fastapi.tiangolo.com/) app for Kubernetes.

- [Setup](SETUP.md)
22 changes: 22 additions & 0 deletions docs/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Setup

This page contain information on how to set up the project locally.

## Install Poetry

- Install it from the [Poetry Installation](https://python-poetry.org/docs/#installation) page.
- Check the installation by running:

```shell
poetry --version
```

- Make sure your version is **1.2.2 or higher.**

### Install Dependencies via Poetry

1. Run in terminal:

```sh
poetry install
```
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: FastAPI on Kubernetes
site_url: https://svaponi.github.io/fastapi-k8s
nav:
- Home: INDEX.md
- Setup: SETUP.md
- Home: index.md
- Setup: setup.md
theme: readthedocs

0 comments on commit add9cc1

Please sign in to comment.