Skip to content
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ everyone who is interested in contributing.
## Documentation testing

We treat documentation like code. Therefore, we use processes similar to those used for code to
maintain standards and quality of documentation.
maintain sFtandards and quality of documentation.

We have tests:

Expand Down
12 changes: 6 additions & 6 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,12 @@ export default defineConfig({
{
label: "Onboarding Hub",
collapsed: true,
autogenerate: { directory: "Resources/Onboarding Hub" },
autogenerate: { directory: "Resources/onboarding_hub" },
},
{
label: "Quality Assurance",
collapsed: true,
autogenerate: { directory: "Resources/Quality Assurance" },
autogenerate: { directory: "Resources/quality_assurance" },
},
{
label: "Frequently Asked Questions (FAQ)",
Expand All @@ -117,24 +117,24 @@ export default defineConfig({
{
label: "SplashKit",
collapsed: true,
autogenerate: { directory: "Products/SplashKit" },
autogenerate: { directory: "products/splashkit" },
},
{
label: "OnTrack",
collapsed: true,
autogenerate: { directory: "Products/OnTrack" },
autogenerate: { directory: "products/ontrack" },
},
{
label: "CourseFlow",
collapsed: true,
autogenerate: { directory: "Products/CourseFlow" },
autogenerate: { directory: "products/courseFlow" },
},
],
},
{
label: "Teams and Contributions",
collapsed: true,
autogenerate: { directory: "Teams and Contributions" },
autogenerate: { directory: "teams_and_contributions" },
},
{
label: "Feedback",
Expand Down
41 changes: 41 additions & 0 deletions public/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# public

## Purpose
The `public` directory contains static files and resources such as organizational structures, contributing guides, and utility scripts for the OnTrack and SplashKit projects. These files support documentation and contribute to project workflows.

## Structure

### 1. `company-structure/`
- **Purpose**: Stores images of the organizational structure for different terms.
- **Contents**:
- `2024-t2-thoth-tech-structure.png`: Organizational structure for Term 2, 2024.
- `2024-t3-thoth-tech-structure.png`: Organizational structure for Term 3, 2024.

---

### 2. `ontrack/contributing-guide/`
- **Purpose**: Contains images supporting the OnTrack contributing guide documentation.
- **Contents**:
- `backendmigrationerror.png`: Visual representation of a backend migration error.
- `correctsigninpage.png`: Example of a correctly implemented sign-in page.
- `dockererror.png`: Error encountered during Docker setup.
- `gitfetchexample.png`: Example usage of the Git fetch command.
- `gitremotes.png`: Guide to Git remotes configuration.
- `incorrectsigninpage.png`: Example of a poorly implemented sign-in page.
- `mysqlerror.png`: Common MySQL error during development.
- `poststarterror.png`: Error related to post-start operations.

---

### 3. `scripts/`
- **Purpose**: Contains utility scripts for integration and management tasks.
- **Contents**:
- `ms_teams_planner_export_script.py`: Python script for exporting tasks from Microsoft Teams Planner.

---

## Notes
- Follow **snake_case** for new file names added to this directory.
- Ensure that static files like images and scripts are documented here for ease of navigation.
- Keep the `public` directory organized by creating additional subdirectories as needed.

44 changes: 44 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# src

## Purpose
The `src` directory is the core of the repository, containing all essential resources for the OnTrack and SplashKit projects. It houses static assets, technical documentation, style configurations, and resources for onboarding and quality assurance.

## Structure

### 1. `assets/`
- **Purpose**: Stores static assets like logos and images.
- **Contents**:
- `thoth-logo.png`: The primary logo for Thoth Tech.
- `thoth-tech-logo-glow.png`: A glowing variation of the Thoth Tech logo.

---

### 2. `content/`
- **Purpose**: Contains the main documentation for various projects and modules.
- **Subdirectories**:
- **`docs/`**: Core technical documentation organized into:
- **`Products/`**: Documentation for key projects:
- **`CourseFlow/`**:
- Contains project files, including data flow diagrams, entity relationships, and user stories.
- **`OnTrack/`**:
- Covers deployment, file submission, multiple organizations, and setup guides.
- Includes `review-ontrack-github.md` for GitHub reviews.
- **`SplashKit/`**:
- Documents game development, arcade machines, and website details.
- **`old-files-and-folders/`**: Archived files for reference purposes.
- **Files in `content/`**:
- `config.ts`: Configuration file for Astro framework.

---

### 3. `styles/`
- **Purpose**: Contains CSS and style-related files for customizing the documentation website.
- **Note**: Ensure any new styles align with existing design guidelines.

---

### Notes
- Follow **snake_case** for any new file or folder names.
- All documentation updates should be reflected in the `astro.config.mjs` file for proper linkage.
- Static assets for all modules and subprojects should be added to the `assets/` folder.

Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Panopto OAuth2 Integration Guide (Updated)
---

# Panopto OAuth2 Integration Guide (Updated)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Panopto Upload Process"
description: "Guide on uploading content to Panopto for OnTrack documentation."
---

# Panopto Video Upload Process

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To help with assembling the company reports/handover documents, we have a Python
the current tasks from the MS Teams Planner board and exports them as a `csv`, for inclusion as a
table in the document. It uses the Microsoft Graph API to access the data.

The script can be found [here](/scripts/MSTeamsPlannerExportScript.py). It's pretty simple to use,
The script can be found [here](/scripts/ms_teams_planner_export_script.py). It's pretty simple to use,
and for a step-by-step guide see below:

## Steps
Expand All @@ -29,7 +29,7 @@ and for a step-by-step guide see below:
Copy and paste the following command into your terminal, then press **Enter**:

<Code
code="curl -O https://raw.githubusercontent.com/thoth-tech/ThothTech-Documentation-Website/refs/heads/main/public/scripts/MSTeamsPlannerExportScript.py && python MSTeamsPlannerExportScript.py"
code="curl -O https://raw.githubusercontent.com/thoth-tech/ThothTech-Documentation-Website/refs/heads/main/public/scripts/ms_teams_planner_export_script.py && python ms_teams_planner_export_script.py"
lang="bash"
></Code>

Expand Down