Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated some wording, made the tree clearer and less confusing.
  • Loading branch information
dortnum authored Oct 17, 2024
1 parent 7c5280c commit 9fc2845
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Skyscrapers products & services documentation

This repository contains user-level documentation for our product & service offering, as well as documentation on tools and best practices. The main target audience are the Skyscrapers customers.
This repository contains user-level technical documentation for our product & service offering, documentation on tools and best practices as well as the way we do our work (processes). The main target audience are the Skyscrapers customers.

This comment has been minimized.

Copy link
@duboisph

duboisph Oct 17, 2024

Member

@dortnum Only technical? From KES we were intending to add our Security Policy etc too.

This comment has been minimized.

Copy link
@dortnum

dortnum Oct 17, 2024

Author Contributor

If you scroll down, there are two more sections (onboarding and process and services).

Security policy does not fall under technical imo, it will need to be added to Process and services part.

btw, I was about to ping you about the sec policy, good that you asked.

This comment has been minimized.

Copy link
@duboisph

duboisph Oct 17, 2024

Member

Aah ok, I understand the intend now. Ok perfect 👌


In this knowledge base you'll find information on how to use your Kubernetes cluster, how to create a Concourse pipeline, how to manage containerized applications and how to monitor them, etc. You'll also find some opinionated good practices, tips and recommendations, along with references to external sources of documentation and articles. It's intended to be browsed mainly through GitHub or a local git clone, so the file tree acts as the table of contents.
## Technical Documentation

## Table of contents
In this knowledge base you'll find information on how to use your Kubernetes cluster, how to create a Concourse pipeline, how to manage containerized applications and how to monitor them, etc. You'll also find some opinionated good practices, tips and recommendations, along with references to external sources of documentation and articles. It's intended to be browsed mainly through GitHub or a local git clone, so the file tree acts as the table of contents.

This comment has been minimized.

Copy link
@duboisph

duboisph Oct 17, 2024

Member

@dortnum I believe this section needs an update. Afaik it is no longer primarily intended to be browsed through GH or clone, but via https://docs.skyscrapers.eu


Each header points to the main README of each platform offering. Within each folder you'll also find documentation on more advanced and/or specific topics.

Expand Down Expand Up @@ -41,10 +41,19 @@ Each header points to the main README of each platform offering. Within each fol
- [UDP](kubernetes/udp.md)
- [Vault](kubernetes/vault.md)
- [MongoDB Atlas](mongodb_atlas/README.md)
- [Onboarding](onboarding/README.md) - All resources related to the onboarding track
- [Kubernetes Platform Orientation](onboarding/orientation.md) - Kubernetes Platform Orientation workshop material
- [Runbook](runbook.md) - Description of our custom monitoring alerts with possible remediations
- Process and services

## Onboarding

Here you will find the resources related to the onboarding track for our new customers.

- [Onboarding](onboarding/README.md)
- [Kubernetes Platform Orientation](onboarding/orientation.md) - Kubernetes Platform Orientation workshop material

## Process and services

This is where you can find information on certain aspects of the DOaaS that we offer (.e.g. the way we offer our every day support to you).

- [DevOps-as-a-Service: Platform Users and User Roles](Process_and_Services/platformusersandroles.md)
- [Skyscrapers Support Process](support_process.md)

Expand Down

0 comments on commit 9fc2845

Please sign in to comment.