Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Introduction and Explanation for the IaaS Layer

Đang mở
  • Có gì không ổn?
#101 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

@berendt đang làm issue này rồi.

Từ ngày 10/11/2023.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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

Ngôn ngữ chính
JavaScript
Star
18
Fork
10
Merge trung bình
10 giờ 5 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của SovereignCloudStack/docs

Tất cả issue của SovereignCloudStack/docs

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.