Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Introduction and Explanation for the IaaS Layer

Abierto
  • ¿Algo no está bien?
#101 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@berendt ya está trabajando en esto.

Desde el 10/11/2023.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

documentation IaaS

As the Sovereign Cloud Stack (SCS) continues to evolve, there is an increasing need for clear and comprehensive documentation, especially for its Infrastructure as a Service (IaaS) layer. The documentation should serve as resource for new users and contributors, helping them understand the architecture and functionalities of the IaaS layer within the SCS ecosystem and interplay of OSISM. The goal is to create an overview section as seen in the standard SCS-002-v2

├── IaaS Layer
│    ├── Overview
│    │        ├── Architecture
│    │        ├── Compute
│    │        ├── Storage
│    │        ├── Network
│    │        ├── Control
│    │        └── Knowledge
...

within the existing SCS documentation that accomplishes the following:

  1. Provides a detailed introduction to the IaaS layer, explaining its role, benefits, and the problems it solves within the SCS framework. Important: Distinguish two different intros for operators coming from either "OpenStack" or "Virtual Machine Orchestration (VMWare, HyperV, ProxMox – Starting from Scratch)". Compare the already existing Container Layer introduction: https://docs.scs.community/docs/container/
  2. Offers a visual representation of the IaaS layer’s architecture to enhance user comprehension.
  3. Lists the prerequisites for using the IaaS layer, including necessary hardware, software, and technical knowledge for from either "OpenStack" or "Virtual Machine Orchestration (VMWare, HyperV, ProxMox – Starting from Scratch)".
  4. Presents a "Quickstart" guide for new users to get a basic setup running, with step-by-step instructions suitable for testing environments. See section of "Deployment Examples".
  5. Explains how to configure the IaaS layer, detailing the various options, parameters, and settings available.
  6. Guides users on how to contribute to the IaaS layer's development, including issue submission and participation in discussions.

Action Items:

  • Draft an introductory document for the IaaS layer.
  • Develop a comprehensive visual diagram of the IaaS layer's architecture.
  • Compile a list of prerequisites for the IaaS layer setup.
  • Create a "Quickstart" guide for the IaaS layer.
  • Detail the configuration options available for the IaaS layer.
  • Prepare a contribution guide for the IaaS layer.

As a lof of this is covered within the OSISM documentation it is important to distinguish which content should be written from the SCS perspective and what can be implemented via copying content from the OSISM Docs via the docs sync workflow such as the Guides.

The introduction should be aligned with the SCS Documentation structure, reflecting the logical hierarchy and aiding users in navigating the complex SCS ecosystem.

By accomplishing this, we aim to foster a transparent, inclusive community environment and facilitate the onboarding process for new users and contributors to the SCS.

See also: https://github.com/SovereignCloudStack/issues/issues/124

Lenguaje dominante
JavaScript
Estrellas
18
Forks
10
Merge medio
15 h 22 min
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de SovereignCloudStack/docs

Todos los issues de SovereignCloudStack/docs

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.