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

12 add a description of deployment methods with placeholders #23

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
title: Just the Docs Template
description: A starter template for a Jeykll site using the Just the Docs theme!
title: OS2 Documentation template
description: A starter template for an OS2 product documentation build using Jeykll and Just the Docs theme!
theme: just-the-docs

url: https://just-the-docs.github.io

aux_links:
Template Repository: https://github.com/just-the-docs/just-the-docs-template

logo: "/assets/images/os2.jpeg"

mermaid:
# Version of mermaid library
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
version: "10.9.1"
Binary file added assets/images/os2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Getting Started with [Your Application Name]

Welcome to the **[Your Application Name]**! This guide will help you get started with our application and provide links to resources tailored for different audiences. Whether you're a Product Owner, Developer, System Administrator, or End-User, we have the information you need to succeed.

## Table of Contents
1. [Introduction](#introduction)
2. [System Architecture](#system-architecture)
3. [Getting Started Guides](#getting-started-guides)
- [Product Owners](#product-owners)
- [Developers](#developers)
- [System Administrators](#system-administrators)
- [End-Users](#end-users)
4. [Additional Resources](#additional-resources)
5. [Feedback](#feedback)

## Introduction
[Your Application Name] is designed to [briefly describe the purpose and key features of the application]. This guide aims to provide you with the necessary resources to get started quickly and effectively.

## Architecture overview
For an overview of the system architecture, including components, relationships, and design decisions, please refer to our dedicated architecture document:

🗺️ **[Architecture Overview](link-to-architecture.md)**

This document provides essential insights into how the application is structured and how its various parts interact.

## Getting Started Guides

### Business Stakeholders
For Business Stakeholders looking to understand the application's capabilities and how it aligns with business goals, visit the following guide:

🏛️ **[Getting Started Guide for Business Stakeholders](link-to-business-stakeholders-guide)**

### Developers
If you're a Developer wanting to set up your development environment and contribute to the codebase, check out:

💻 **[Getting Started Guide for Developers](link-to-developer-guide)**

### System Administrators
System Administrators can find deployment and maintenance instructions in:

🧑‍🔧 **[Getting Started Guide for System Administrators](link-to-admin-guide)**

### End-Users
End-Users seeking to utilize the application effectively should refer to:

👥 **[Getting Started Guide for End-Users](link-to-user-guide)**

## Additional Resources
Explore more resources related to [Your Application Name]:
- [Issue Tracker](link-to-issue-tracker)
- [Community Forum](link-to-forum)
- [FAQs](link-to-faqs)

## Feedback
We value your input! If you have suggestions or feedback on this guide or any of the linked resources, please let us know through our feedback form: [Feedback Form Link].