Skip to content

Commit

Permalink
chore: cleanup some typos and wording
Browse files Browse the repository at this point in the history
  • Loading branch information
Darkflame72 committed Oct 1, 2023
1 parent d0f5c73 commit 6af9d68
Show file tree
Hide file tree
Showing 14 changed files with 99 additions and 174 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Setup

This project uses pnpm to manage my dependencies. Run `pnpm install` to setup and `pnpm dev` to run a dev environment.
This project uses pnpm to manage dependencies. Run `pnpm install` to setup and `pnpm dev` to run a dev environment.
19 changes: 16 additions & 3 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,35 @@ export default defineConfig({
logo: {
light: './src/assets/logo-light.png',
dark: './src/assets/logo-dark.png',
replacesTitle: true,
},
social: {
github: 'https://github.com/Tuhura-Tech/Wiki',
discord: 'https://discord.gg/PNxh7cwKfQ',
},
editLink: {
baseUrl: 'https://github.com/Tuhura-Tech/Wiki/edit/main/docs/',
baseUrl: 'https://github.com/Tuhura-Tech/Wiki/blob/main/',
},
sidebar: [
{
label: 'Guides',
autogenerate: { directory: 'guides' },
items: [
{ label: "About our Guides", link: 'guides/about' },
{ label: "Javascript", autogenerate: { directory: 'guides/javascript' } },
// { label: "Python", autogenerate: { directory: 'guides/python' } },
{ label: "Git", autogenerate: { directory: 'guides/git' } },
{ label: "Cybersecurity", autogenerate: { directory: 'guides/cybersecurity' } },

]
},
{
label: 'NCEA Resources',
autogenerate: { directory: 'ncea' },
items: [
{ label: "About our Resources", link: 'guides/about' },
{ label: "NCEA Level 2", autogenerate: { directory: 'ncea/level-2' } },
{ label: "NCEA Level 3", autogenerate: { directory: 'ncea/level-3' } },

]
},
{
label: 'Projects',
Expand Down
7 changes: 5 additions & 2 deletions src/components/about-tuhura.astro
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
---
import { Image } from "astro:assets";
import logoIcon from "./../assets/logo.svg";
interface Props {
title: string;
}
const { title } = Astro.props;
---

<article class="flex not-content" aria-labelledby="about-astro-heading">
<small id="about-astro-heading">
<article class="sl-flex not-content" aria-labelledby="about-tuhura-heading">
<small id="about-tuhura-heading">
{title}
<span class="sr-only">Tūhura Tech</span>
</small>
Expand Down
10 changes: 10 additions & 0 deletions src/content/docs/guides/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: About our Guides
description: About the guides in this wiki.

sidebar:
# Make this always the first
order: 1
---

As part of our mission we make our resources and guides public which you can use to learn new topics.
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,37 @@ title: Basics
description: This is a page in my Starlight-powered site
---

import { Tabs, TabItem } from "@astrojs/starlight/components";

## Installing Git

::: code-group
<Tabs>
<TabItem label="Linux/Unix">

```sh [Chocolatey]
choco install git
```
**Debian/Ubuntu**

```sh [Homebrew]
brew install git
```

```sh [Debian]
```sh
sudo apt install git
```

:::
For other distros look at the git documentation found [here](https://git-scm.com/download/linux).

</TabItem>
<TabItem label="MacOS">

```sh
brew install git
```

</TabItem>
<TabItem label="Windows">

```sh
winget install --id Git.Git -e --source winget
```

</TabItem>
</Tabs>

## Creating a git repository

Expand All @@ -44,7 +58,6 @@ Once a change has been saved to staging we can commit ("save") that change to ve
## Git Remotes (GitHub/GitLab/ForgeJo)

## Reverting Changes
## Branches and Pull Requests
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/guides/javascript/setting-up.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Setting Up
description: This is a page in my Starlight-powered site
description: This is how to setup a JavaScript enfironment.
---

import { Tabs, TabItem } from "@astrojs/starlight/components";
Expand Down
154 changes: 0 additions & 154 deletions src/content/docs/guides/python/setting-up.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hero:
file: ../../assets/logo.svg
actions:
- text: Our guides
link: ./guides/cybersecurity/competitions
link: ./guides/about
icon: right-arrow
variant: primary
- text: Our Website
Expand Down
10 changes: 10 additions & 0 deletions src/content/docs/ncea/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: About our Resources
description: About the NCEA resources in this wiki.

sidebar:
# Make this always the first
order: 1
---

These are a collection of resources that can be used for courses that relate to NCEA.
8 changes: 8 additions & 0 deletions src/content/docs/ncea/level-2/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: About
description: About the guides in this wiki.

sidebar:
# Make this always the first
order: 1
---
8 changes: 8 additions & 0 deletions src/content/docs/ncea/level-3/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: About
description: About the guides in this wiki.

sidebar:
# Make this always the first
order: 1
---
8 changes: 8 additions & 0 deletions src/content/docs/tuhura-tech/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Contributing to this Wiki
description: Details on how to contribute to this Wiki
---

## Setup

This project uses pnpm to manage dependencies. Run `pnpm install` to setup and `pnpm dev` to run a dev environment.
6 changes: 6 additions & 0 deletions src/content/docs/tuhura-tech/infrastructure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Our Infrastructure
description: Details on our public infrastructure
---

This is currently a WIP with the intention of it being fully open source and managed using GitOps.
2 changes: 1 addition & 1 deletion tailwind.config.cjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const starlightPlugin = require('@astrojs/starlight-tailwind');

// Generated color palettes
const accent = { 200: '#aad7a0', 600: '#258100', 900: '#0d3e00', 950: '#072d00' };
const accent = { 200: '#bbcfba', 600: '#427b42', 900: '#213921', 950: '#192819' };
const gray = { 100: '#f4f7f3', 200: '#eaf0e8', 300: '#bdc4bb', 400: '#82907f', 500: '#4f5c4d', 700: '#303c2d', 800: '#1f2a1c', 900: '#151a13' };

/** @type {import('tailwindcss').Config} */
Expand Down

0 comments on commit 6af9d68

Please sign in to comment.