Skip to content

Commit

Permalink
Merge pull request 'Adds "Get started" and "Tools & Packages" section…
Browse files Browse the repository at this point in the history
…s' (#10) from andres/prodverse.ixpantia.com:T8 into main

Reviewed-on: https://secure.ixpantia.com/prodverse/prodverse.ixpantia.com/pulls/10
  • Loading branch information
andrea-ixpantia committed Jan 5, 2024
2 parents f43e3a3 + 29076c4 commit ce1d450
Show file tree
Hide file tree
Showing 11 changed files with 313 additions and 14 deletions.
22 changes: 22 additions & 0 deletions docs/en/get_started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Get started

Hello there! This is your first step to becoming an expert at taking
R applications to production. In this section you will find many
tutorial articles that will help you get up and running with the
prodverse.

[Shiny in production with the prodverse](shiny_in_prod.md) is a
tutorial that will take you through the process of building a very
minimal Shiny application with user authentication and deploying it to
a server with replicas and load balancing using **faucet** and
**tapLock**. (The app in the tutorial is very minimal and not
particularly useful, but it is a good starting point for understanding
the prodverse.)

[Scaling Plumber with faucet](scaling_plumber.md) is a tutorial
that will walk you through the process of scaling a Plumber API with
**faucet**. First you will install faucet and test it out locally,
then you will use Docker to build a container image for your API.
The API will be slow to show how **faucet** will attempt to make it
faster by adding replicas and load balancing.

Empty file.
13 changes: 6 additions & 7 deletions docs/en/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
template: overrides/home.html
title: Material for MkDocs
social:
cards_layout_options:
title: Documentation that simply works
title: prodverse
hide:
- navigation
- toc
Expand Down Expand Up @@ -45,9 +42,11 @@ hide:
<div class="text">
<h1>prodverse</h1>
<p>
The prodverse is a toolbox for taking your data science projects to production.
The ecosystem is built to help you and your team build, deploy,
and maintain production-ready data products written with the R programming language.
The prodverse is a toolbox designed by <a
href="https://www.ixpantia.com/en/">ixpantia</a> for taking your
data science projects to production. The ecosystem is built to help
you and your team build, deploy, and maintain production-ready data
products written with the R programming language.
</p>
</div>
</div>
Expand Down
42 changes: 42 additions & 0 deletions docs/en/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
template: overrides/home.html
title: Tools & Packages
hide:
- navigation
---

<style>

h2 {
font-size: 2em !important;
}

.hex {
max-width: 50%;
max-height: 150px;
}

</style>

## faucet <a href="https://github.com/ixpantia/faucet"><img src="/figures/faucet.png" align="right" class="hex"></a>

faucet is a web server that makes Shiny applications and Plumber APIs available
to the web with minimal configuration, replication, logging and load balancing
out of the box. faucet is designed to be used on any platform, cloud or
on-premise, and is compatible with any Shiny application or Plumber API. faucet
is built with Rust to deliver high performance and low resource usage. Learn
more from the faucet [documentation](https://ixpantia.github.io/faucet/).

---

## tapLock <a href="https://github.com/ixpantia/taplock"><img src="/figures/tapLock.png" align="right" class="hex"></a>

tapLock is an R package that provides a simple yet powerful and secure way to
lock down Shiny applications and Plumber APIs with Single Sign-On (SSO). tapLock
uses the OAuth 2.0 protocol with OpenID Connect (OIDC) to authenticate users
with many popular identity providers (IdPs) such as Google, Entra ID / Active
Directory, Auth0 and many more. tapLock uses a unique approach to secure Shiny
applications and Plumber APIs that requires no mayor changes to existing code.
Learn more from the tapLock [documentation](https://ixpantia.github.io/tapLock/).

---
20 changes: 20 additions & 0 deletions docs/es/get_started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Aprende

¡Hola! Este es tu primer paso para convertirte en un experto en llevar
aplicaciones R a producción. En esta sección encontrarás muchos
artículos tutoriales que te ayudarán a comenzar con el
prodverse.

[Shiny en producción con el prodverse](shiny_in_prod.md) es un
tutorial que te guiará a través del proceso de construir una aplicación Shiny muy
mínima con autenticación de usuario y desplegarla en un servidor con réplicas y balanceo de carga usando **faucet** y
**tapLock**. (La aplicación en el tutorial es muy básica y no
particularmente útil, pero es un buen punto de partida para entender
el prodverse.)

[Escalando Plumber con faucet](scaling_plumber.md) es un tutorial
que te llevará a través del proceso de escalar una API Plumber con
**faucet**. Primero instalarás faucet y lo probarás localmente,
luego usarás Docker para construir una imagen de contenedor para tu API.
La API será lenta para mostrar cómo **faucet** intentará hacerla
más rápida agregando réplicas y balanceo de carga.
Empty file.
14 changes: 7 additions & 7 deletions docs/es/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
template: overrides/home.html
title: Material for MkDocs
social:
cards_layout_options:
title: Documentation that simply works
title: prodverse
hide:
- navigation
- toc
Expand Down Expand Up @@ -45,9 +42,12 @@ hide:
<div class="text">
<h1>prodverse</h1>
<p>
El prodverse es una caja de herramientas para llevar tus proyectos de ciencia de datos a la producción.
El ecosistema está construido para ayudarte a ti y a tu equipo a construir, desplegar,
y mantener productos de datos listos para producción escritos con el lenguaje de programación R.
El prodverse es una caja de herramientas diseñada por <a
href="https://www.ixpantia.com/es/">ixpantia</a> para llevar tus
proyectos de ciencia de datos a la producción. El ecosistema está
construido para ayudarte a ti y a tu equipo a construir, desplegar,
y mantener productos de datos listos para producción escritos con
el lenguaje de programación R.
</p>
</div>
</div>
Expand Down
43 changes: 43 additions & 0 deletions docs/es/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
template: overrides/home.html
title: Herramientas y paquetes
hide:
- navigation
---

<style>

h2 {
font-size: 2em !important;
}

.hex {
max-width: 50%;
max-height: 150px;
}

</style>



## faucet <a href="https://github.com/ixpantia/faucet"><img src="/figures/faucet.png" align="right" class="hex"></a>

faucet es un servidor web que hace que las aplicaciones Shiny y las APIs Plumber estén disponibles
en la web con una configuración mínima, replicación, logging y balanceo de carga
de manera automática. faucet está diseñado para ser utilizado en cualquier plataforma, nube o
local, y es compatible con cualquier aplicación Shiny o API Plumber. faucet
está construido con Rust para ofrecer un alto rendimiento y bajo uso de recursos. Aprende
más de la [documentación de faucet](https://ixpantia.github.io/faucet/es/).

---

## tapLock <a href="https://github.com/ixpantia/taplock"><img src="/figures/tapLock.png" align="right" class="hex"></a>

tapLock es un paquete de R que proporciona una forma sencilla pero potente y segura de
bloquear aplicaciones Shiny y APIs Plumber con Inicio de Sesión Único (SSO). tapLock
utiliza el protocolo OAuth 2.0 con OpenID Connect (OIDC) para autenticar usuarios
con muchos proveedores de identidad populares (IdPs) como Google, Entra ID / Active
Directory, Auth0 y muchos más. tapLock utiliza un enfoque único para asegurar aplicaciones Shiny
y APIs Plumber que no requiere cambios mayores en el código existente. Aprende más de la [documentación de tapLock](https://ixpantia.github.io/tapLock/).

---
Binary file added docs/figures/tapLock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
165 changes: 165 additions & 0 deletions docs/figures/tapLock.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,20 @@ plugins:
build: true
nav:
- Home: index.md
- Tools & Packages: tools.md
- Get started:
- Introduction: get_started/index.md
- Shiny in production with the prodverse: get_started/shiny_in_prod.md
- locale: es
default: false
name: Español
build: true
nav:
- Inicio: index.md
- Herramientas y Paquetes: tools.md
- Aprende:
- Introducción: get_started/index.md
- Shiny en producción con el prodverse: get_started/shiny_in_prod.md

markdown_extensions:
- attr_list
Expand Down

0 comments on commit ce1d450

Please sign in to comment.