doc refac for new doc website

This commit is contained in:
bluxmit 2022-05-23 09:36:06 +00:00
parent ebf0ceaec8
commit e70c753b18
41 changed files with 240 additions and 77 deletions

View file

@ -65,8 +65,6 @@ COPY ./mkdocs/Ara.png /home/docs/docs/assets/home/
COPY ./mkdocs/Blast-radius.png /home/docs/docs/assets/home/
COPY ./mkdocs/Terraform-Rover.png /home/docs/docs/assets/home/
COPY ./mkdocs/helpers.py /home/docs/macros
COPY docs/ansible.md /home/docs/docs/
COPY docs/terraform.md /home/docs/docs/
RUN apt-get -y update \
&& echo "------------------------------------------------------ ansible ara" \

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Ansible-Terraform Workspace
@ -8,7 +8,7 @@ Dockerized development environment for Ansible and Terraform. Workspace will hel
visualize planned terraform changes; display ansible hosts plays; schedule and observe executions.
<p align="center">
<img src="https://raw.githubusercontent.com/bluxmit/alnoda-workspaces/main/workspaces/ansible-terraform-workspace/img/ansible-terraform-wid-collage.png" alt="Collage" width="750">
<img src="img/ansible-terraform-wid-collage.png" alt="Collage" width="750">
</p>
## Why this images
@ -72,12 +72,19 @@ Image is built from **Ubuntu 20.4** with the additional CLI apps
- **Job scheduler:** cron
## Docs
See our guides on [**getting started**](docs/getting-started.md) and [**advanced features**](../ubuntu-workspace/docs/workspaces.md).
See our guides
- [**project docs**](https://docs.alnoda.org/)
- [**getting started - Ansible**](https://docs.alnoda.org/ansible-terraform-workspace/ansible-tools/)
- [**getting started - Terraform**](https://docs.alnoda.org/ansible-terraform-workspace/terraform-tools/)
## Demo
<div align="center" style="font-style: italic;">
Demo: Ansible-Terraform workspace
</div>
<p align="center">
<img src="https://raw.githubusercontent.com/bluxmit/alnoda-workspaces/main/workspaces/ansible-terraform-workspace/img/ansible-terraform-wid.gif" alt="Htop" width="900">
<img src="img/ansible-terraform-wid.gif" alt="Htop" width="900">
</p>

View file

@ -5,10 +5,7 @@
nav:
- Home: README.md
- My apps: pages/my-apps.md
- Tutorials:
- Get started: getting-started.md
- Ansible: ansible.md
- Terraform: terraform.md
- Docs: https://docs.alnoda.org/ansible-terraform-workspace/
# ===========================================================
@ -17,7 +14,7 @@ nav:
site_name: Infra Workspace
repo_url: https://github.com/bluxmit/alnoda-workspaces
site_url: https://alnoda.org
site_url: https://docs.alnoda.org
edit_uri: ""
# ===========================================================
@ -49,8 +46,8 @@ theme:
extra:
# Link to open when your logo is clicked
homepage: https://alnoda.org
host_url: http://localhost
homepage: https://docs.alnoda.org
host_url: http://docs.alnoda.org
plugins:
- search

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Base-workspace
Containerized Linux environment for running jobs on schedule with browser-based scheduler, terminal and file manager.
@ -12,7 +12,7 @@ You can host on your favourite Rasberry Pi.
docker run --name space-1 --user=root -d -p 8020-8040:8020-8040 alnoda/base-workspace
```
and open [localhost:8020](http://localhost:8020) in browser.
open [localhost:8020](http://localhost:8020) in browser.
## Features
@ -41,14 +41,20 @@ and open [localhost:8020](http://localhost:8020) in browser.
1. If you need to schedule scripts and jobs, monitor executions, upload and download files.
## Docs
See our guides on [**getting started**](https://docs.alnoda.org/base-workspace/) and [**advanced features**](../ubuntu-workspace/docs/workspaces.md).
See our guides
- [**project docs**](https://docs.alnoda.org/)
- [**getting started**](https://docs.alnoda.org/get-started/common-features/)
## Demo
<div align="center" style="font-style: italic;">
Demo: Base workspace
</div>
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/workspaces/base-workspace/img/base-workspace.gif" alt="Base Workspace" width="750">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/workspaces/base-workspace/img/base-workspace.gif?raw=true" alt="Base Workspace" width="750">
</p>

View file

@ -14,7 +14,7 @@ nav:
site_name: Workspace
repo_url: https://github.com/bluxmit/alnoda-workspaces
site_url: https://alnoda.org
site_url: https://docs.alnoda.org
edit_uri: ""
# ===========================================================
@ -46,8 +46,8 @@ theme:
extra:
# Link to open when your logo is clicked
homepage: https://alnoda.org
host_url: http://localhost
homepage: https://docs.alnoda.org
host_url: http://docs.alnoda.org
plugins:
- search

View file

@ -7,8 +7,8 @@ USER root
COPY supervisord-codeserver.conf /etc/supervisord/
COPY ./mkdocs/mkdocs.yml /home/docs/mkdocs.yml
COPY ./mkdocs/helpers.py /home/docs/macros
COPY docs/getting-started.md /home/docs/docs/getting-started.md
COPY ./mkdocs/IDE.jpg /home/docs/docs/assets/home/
COPY ./mkdocs/README.md /home/docs/docs/README.md

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Code-server workspace
General-purpose dockerized development environment. Fully isolated inside a docker container.
@ -49,7 +49,13 @@ VS-Code extensions and works in browser.
- **Job scheduler:** cron
## Docs
See our guides on [**getting started**](docs/getting-started.md) and [**advanced features**](../ubuntu-workspace/docs/workspaces.md).
See our guides
- [**project docs**](https://docs.alnoda.org/)
- [**getting started**](https://docs.alnoda.org/get-started/common-features/)
## Demo
<div align="center" style="font-style: italic;">
Demo: Code-server workspace

View file

@ -0,0 +1,70 @@
# ===========================================================
# NAVIGATION
# ===========================================================
nav:
- Home: README.md
- My apps: pages/my-apps.md
- Docs: https://docs.alnoda.org/codeserver-workspace/
# ===========================================================
# CONFIGURATION
# ===========================================================
site_name: My workspace
repo_url: https://github.com/bluxmit/alnoda-workspaces
site_url: https://docs.alnoda.org
edit_uri: ""
# ===========================================================
# APPEARANCE
# ===========================================================
theme:
name: 'material'
favicon: 'assets/favicon.ico'
logo: 'assets/Alnoda-logo.svg'
custom_dir: overrides
icon:
repo: fontawesome/brands/git-alt
features:
- navigation.instant
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
primary: brown
accent: deep orange
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to dark mode
primary: orange
accent: red
extra:
# Link to open when your logo is clicked
homepage: https://docs.alnoda.org
host_url: http://docs.alnoda.org
plugins:
- search
# Enable Macros and jinja2 templates
- macros:
module_name: macros/helpers
extra_javascript:
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6

View file

@ -6,7 +6,8 @@ FROM ${docker_registry}/ide-workspace:${image_tag}
USER root
COPY settings.json /home/abc/.theia/settings.json
COPY docs/tutorial.md /home/docs/docs/tutorial.md
COPY ./mkdocs/mkdocs.yml /home/docs/mkdocs.yml
RUN apt-get -y update \
# && echo "------------------------------------------------------ utils" \

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Elasticsearch workspace
Several Elasticsearch CLI tools in a containerized dev/admin workspace.
@ -15,7 +15,7 @@ migrate to other clusters, export and import Elasticsearch data to S3.
## Start
```
docker run --name elawid-1 -d -p 8020-8035:8020-8035 alnoda/elasticsearch-workspace
docker run --name elawid-1 -d -p 8020-8040:8020-8040 alnoda/elasticsearch-workspace
```
and open [localhost:8020](http://localhost:8020) in browser.
@ -56,4 +56,9 @@ Image is built from **Ubuntu 20.4** with the additional CLI apps
- **Job scheduler:** cron
## Docs
See our guides on [**getting started**](docs/getting-started.md) and [**advanced features**](../ubuntu-workspace/docs/workspaces.md).
See our guides
- [**getting started**](https://docs.alnoda.org/get-started/common-features/)
- [**workspace docs**](https://docs.alnoda.org/elasticsearch-workspace/)
- [**project docs**](https://docs.alnoda.org/)

View file

@ -5,19 +5,16 @@
nav:
- Home: README.md
- My apps: pages/my-apps.md
- Tutorials:
- Get started: getting-started.md
- Ansible: ansible.md
- Terraform: terraform.md
- Docs: https://docs.alnoda.org/elasticsearch-workspace/
# ===========================================================
# CONFIGURATION
# ===========================================================
site_name: Infra Workspace
site_name: Elasticsearch workspace
repo_url: https://github.com/bluxmit/alnoda-workspaces
site_url: https://alnoda.org
site_url: https://docs.alnoda.org
edit_uri: ""
# ===========================================================
@ -39,18 +36,18 @@ theme:
icon: material/toggle-switch-off-outline
name: Switch to light mode
primary: red
accent: orange
accent: red
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to dark mode
primary: red
accent: orange
accent: red
extra:
# Link to open when your logo is clicked
homepage: https://alnoda.org
host_url: http://localhost
homepage: https://docs.alnoda.org
host_url: http://docs.alnoda.org
plugins:
- search

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Go workspace

View file

@ -53,8 +53,8 @@ COPY --from=0 /opt/theia /opt/theia
COPY settings.json /home/abc/.theia/settings.json
COPY supervisord-theia.conf /etc/supervisord/
COPY ./mkdocs/mkdocs.yml /home/docs/mkdocs.yml
COPY ./mkdocs/helpers.py /home/docs/macros
COPY docs/getting-started.md /home/docs/docs/getting-started.md
COPY ./mkdocs/IDE.jpg /home/docs/docs/assets/home/
COPY ./mkdocs/README.md /home/docs/docs/README.md

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# IDE-workspace
General-purpose dockerized development environment. Fully isolated inside a docker container.
@ -49,7 +49,13 @@ VS-Code extensions and works in browser. This means it can run inside a docker c
- **Job scheduler:** cron
## Docs
See our guides on [**getting started**](docs/getting-started.md) and [**advanced features**](../ubuntu-workspace/docs/workspaces.md).
See our guides
- [**project docs**](https://docs.alnoda.org/)
- [**getting started**](https://docs.alnoda.org/get-started/common-features/)
## Demo
<div align="center" style="font-style: italic;">
Demo: IDE workspace

View file

@ -0,0 +1,70 @@
# ===========================================================
# NAVIGATION
# ===========================================================
nav:
- Home: README.md
- My apps: pages/my-apps.md
- Docs: https://docs.alnoda.org/ide-workspace/
# ===========================================================
# CONFIGURATION
# ===========================================================
site_name: Workspace
repo_url: https://github.com/bluxmit/alnoda-workspaces
site_url: https://docs.alnoda.org
edit_uri: ""
# ===========================================================
# APPEARANCE
# ===========================================================
theme:
name: 'material'
favicon: 'assets/favicon.ico'
logo: 'assets/Alnoda-logo.svg'
custom_dir: overrides
icon:
repo: fontawesome/brands/git-alt
features:
- navigation.instant
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
primary: brown
accent: deep orange
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to dark mode
primary: orange
accent: red
extra:
# Link to open when your logo is clicked
homepage: https://docs.alnoda.org
host_url: http://docs.alnoda.org
plugins:
- search
# Enable Macros and jinja2 templates
- macros:
module_name: macros/helpers
extra_javascript:
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Java workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Kafka workspace
Single-node Kafka cluster together with several Kafka CLI tools in containerized dev/admin environment.

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# MkDocs-MagicSpace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Node.js workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# PHP workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Postgres workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Python workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# R workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Redis workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Ruby workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Rust workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Scala workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# SQLite Workspace

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Streamlit workspace

View file

@ -1,5 +1,5 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Ubuntu docker workspace

View file

@ -1,5 +1,5 @@
<p align="center">
<img src="https://github.com/bluxmit/alnoda-workspaces/blob/main/img/Alnoda-white.svg" alt="Alnoda logo" width="150">
<img src="../../img/Alnoda-white.svg" alt="Alnoda logo" width="150">
</p>
# Ubuntu workspace