Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

For Operators - Rewrite Introduction #103

Closed
fdobrovolny opened this issue Nov 8, 2023 · 9 comments · Fixed by #109
Closed

For Operators - Rewrite Introduction #103

fdobrovolny opened this issue Nov 8, 2023 · 9 comments · Fixed by #109
Assignees
Labels
documentation Improvements or additions to documentation work in progress Pull requests that are work in progress, do not merge them

Comments

@fdobrovolny
Copy link
Contributor

No description provided.

@fdobrovolny fdobrovolny added the work in progress Pull requests that are work in progress, do not merge them label Nov 8, 2023
@fdobrovolny
Copy link
Contributor Author

About

As only the sum of different repositories complete the SCS Stack, it is important to have an easy and accessible documentation in one place.

This sentence is out of place remove

@harmathy
Copy link

harmathy commented Nov 8, 2023

There should be a reference on how to contribute to the documentation at the very beginning

#104

@chrisschwa
Copy link
Contributor

What is SCS? Why should I care?
SCS describes a standard as well as a reference implementation of this standard.

Please see our [public web site](https://scs.community/) and specifically the [About SCS](https://scs.community/About/) page.

This Part should be removed, because if you are in the Docs you already "Care".

@harmathy
Copy link

harmathy commented Nov 8, 2023

We need an architectural overview and list what technologies are used

@chrisschwa
Copy link
Contributor

chrisschwa commented Nov 8, 2023

The reference implementation

Under that we need to have a description what the Testbed actually is and specifically what it is NOT.
After reading that part the operator should be able to decide if they want to try it out or they want to build a production deployment.

Following implementations are possible

Fast approach -> Cloud in a Box deployment
after that the Testbed implementation
and the bare-metal deployment as final stage

Link to the specific deployment examples for each part.

@maxwolfs
Copy link
Contributor

maxwolfs commented Nov 8, 2023

We need an architectural overview and list what technologies are used

... using the background container from #102 and go deeper with specific ingredients.

Bildschirmfoto 2023-11-08 um 10 50 14

@maxwolfs
Copy link
Contributor

maxwolfs commented Nov 8, 2023

Container Layer

We need a container layer section after the reference implementation section stating use cases to get started with it - with or without the iaas layer/reference implementation and linking to already existing examples and to the container layer introduction, with the still to come #99.

@maxwolfs
Copy link
Contributor

maxwolfs commented Nov 8, 2023

Public SCS Clouds in production

Link to it: https://docs.scs.community/standards/certification/overview#compliant-cloud-environments

Add the cloud access to testbed resources to Contribute part and link to community pages.

@maxwolfs
Copy link
Contributor

maxwolfs commented Nov 8, 2023

Development of SCS

While the SCS projects tracks the efforts across the released in epics and userstories, the work on the code happens upstream - as such these repositories are usually not found in the SCS GitHub organization. Whenever possible SCS works directly in the upstream projects into

  • CNCF projects,
  • OpenStack,
  • kolla-ansible,
  • OSISM and others.

(TODO: Add the Issues and Bug Section next)

Issues and Bugs

If you can identify the affected component, raise the issue against the relevant repository in the SovereignCloudStack or OSISM space. Otherwise you can use the issues repository. We appreciate PRs as well as issues; please don't forget to sign off your contributions (see contributor guide ).

Add the following info on bug reporting into an issue template.

Contribute and Connect

TODO: add already existing content here

Release Notes

Link to Release Notes: https://docs.scs.community/docs/category/releases
TODO: Add some information about the release cycle.

Standards, Conformity and Certification

How to get compliant? With what am i compliant then? What are the benefits? What does it involve? What to expect in the future? Link to Standards Section: https://docs.scs.community/standards

Get rid of 'Other Resources'

Get In Touch

Come into our Matrix Chat in the SCS | Tech Room.

@maxwolfs maxwolfs self-assigned this Nov 8, 2023
@maxwolfs maxwolfs added the documentation Improvements or additions to documentation label Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation work in progress Pull requests that are work in progress, do not merge them
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants