Merge branch 'thoth-tech:main' into main

.gitignore

@@ -2,3 +2,6 @@ node_modules/
 npm-debug.log*
 **/.DS_Store
 .vscode/
+
+# Local Netlify folder
+.netlify

Projects/Dousaurus-documentation/Options for Hosting Docusaurus Website.md

@@ -0,0 +1,7 @@
+# Options for Hosting Docusaurus Website
+
+This documents consists of hosting platforms recommended by Docusaurus for hosting its website.
+|Platform|Pricing| |--------|-------| |Koyeb|Starter plan: Pay-per-use by the second, $5.50 of free
+monthly usage | |Render| Individuals: Free | |Qovery| Unlimited Developers: Free | |Hostman| $4 per
+month| |Surge| Surge Basic: Free | |Azure Web Apps| Free for personal projects. $13.378 per month
+for production apps.|

Projects/Dousaurus-documentation/Spike Outcome for Render Hosting.md

@@ -0,0 +1,84 @@
+# Spike Outcomes
+
+==================
+
+**Spike:** 1
+
+**Title:** Docusaurus Hosting
+
+**Author:** Onyedikachi Okorie
+
+## Goals / Deliverables
+
+The goal of this report is to determine if Docusaurus website can be hosted on a free hosting
+platform called **Render**.
+
+## Technologies, Tools, and Resources used
+
+- Project Repository: GitHub
+- Hosting Platform: Render
+- Text Editor: VsCode
+
+## Tasks undertaken for Test 1
+
+The following steps were used to test the publishing of docusaurus website on render.
+
+1. Navigate to [https://render.com/](https://render.com/), you would be presented with a page to
+   sign up or sign in. You can sign in using Google.
+2. It takes you to a dashboard, select New at the top right corner and choose Web Service.
+   ![New button](../Dousaurus-documentation/images/render-tut-2.png)
+3. On the next page, input the GitHub repository. The repository used for this test was,
+   [https://github.com/thoth-tech/Company-Operations/tree/main/Projects/docusaurus-website](https://github.com/thoth-tech/Company-Operations/tree/main/Projects/docusaurus-website)
+4. Input the link and click continue.
+   ![Input link](../Dousaurus-documentation/images/render-tut-1.png)
+5. Input the following values to configure the web service.
+   - Name: Docusaurus Hosting
+   - Branch: main
+   - Runtime: Node
+   - Build Command: npm install
+   - Start Command: npm start
+   - Click Create Service
+
+## Tasks undertaken for Test 2
+
+1. Sign into renders dashboard.
+2. On the top right corner, select New and choose Static Website.
+3. On the next page, input the GitHub repository. The repository used for this test was,
+   [https://github.com/thoth-tech/Company-Operations](https://github.com/thoth-tech/Company-Operations)
+4. Input the following details to configure the service
+   - Name: Docusaurus Hosting1
+   - Branch: main
+   - Root Directory: [Projects/docusaurus-website](Projects/docusaurus-website)
+   - Build command: yarn install; yarn build
+   - Publish directory: ./build
+
+## What we found out
+
+The test was unsuccessful for both Test 1 and 2. In Test 1, the build executed successfully but on
+the run command it fails.
+
+- Successful build ![Input link](../Dousaurus-documentation/images/render-tut-3.png)
+- Failed run ![Input link](../Dousaurus-documentation/images/render-tut-4.png)
+
+For Test 2, the deployment server was successfully started but the build failed. Failed run
+![Input link](../Dousaurus-documentation/images/render-tut-5.png)
+
+After testing with a different GitHub repository that contained the docusaurus website
+configuration, the build was successful and Render logs showcased the Site as being live. However,
+on going to the provided URL, it shows the message "Not found."
+![Input link](../Dousaurus-documentation/images/render-tut-6.png)
+
+The failure could be because Render has not been given permission to our repository.
+
+## Open issues
+
+- Render does not have required permission to our repository.
+- On navigating to the link provided by Render for the Live site which deployed successfully, it
+  gives a "Not found" error message.
+  ![Input link](../Dousaurus-documentation/images/render-tut-7.png)
+
+## Recommendations
+
+- Grant Render **write** permission to our repository.
+- Explore and test other free hosting platforms.
+- Do more research on hosting docusaurus on Render.

Projects/Starlight/apparent-asteroid/_redirects

@@ -0,0 +1,2 @@
+<!-- 
+/gh             <https://github.com/Kachi-Okorie/Company-Operations/tree/main/Projects/Starlight/apparent-asteroid> -->

Projects/Starlight/apparent-asteroid/astro.config.mjs

@@ -22,7 +22,7 @@ export default defineConfig({
             },
             {
               label: "Documentation",
-              autogenerate: { directory: "processes/documentation" },
+              autogenerate: { directory: "processes/Documentation" },
             },
             {
               label: "Quality Assurance",
@@ -61,6 +61,12 @@ export default defineConfig({
             directory: "reference",
           },
         },
+        {
+          label: "Policies",
+          autogenerate: {
+            directory: "policies",
+          },
+        },
         {
           label: "Products",
           items: [

Projects/Starlight/apparent-asteroid/netlify.toml

@@ -0,0 +1,4 @@
+
+[build]
+command = "npm run build"
+publish = "dist/"

Projects/Starlight/apparent-asteroid/package.json

@@ -5,7 +5,7 @@
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
-    "build": "astro build",
+    "build": "astro build && cp _redirects dist/_redirects",
     "preview": "astro preview",
     "astro": "astro"
   },

Projects/Starlight/apparent-asteroid/src/content/docs/index.mdx

@@ -35,7 +35,7 @@ import { Card, LinkCard, CardGrid } from "@astrojs/starlight/components";
   <LinkCard
     title="Policies"
     description="Understand what we stand for."
-    href="/teams-and-leadership/leadership-t2-2023/"
+    href="/policies/github-management-policy/"
   />
   <LinkCard
     title="Process"

Projects/Starlight/apparent-asteroid/src/content/docs/policies/.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "MD033": {
+    "allowed_elements": ["ul", "li", "img", "span"]
+  },
+  "MD013": {
+    "tables": false
+  }
+}

Projects/Starlight/apparent-asteroid/src/content/docs/policies/GitHub-Management-Policy.md

@@ -0,0 +1,146 @@
+---
+title: GitHub Management Policy
+---
+
+## GitHub Management Policy
+
+This document provides instructions on how to use GitHub as a Thoth Tech team member.
+
+As a team member who wants to contribute to your team’s project, the following steps should be
+followed to get your code or markdown document published to the main branch of your products
+repository.
+
+## Step 1: Fork the Main Branch of your Products Repository
+
+1. Navigate to the repository that you want to fork and locate Fork on the top right corner of the
+   page.
+
+2. Click on Fork and you would be required to Choose an owner. This is usually your personal GitHub
+   account, add a description if you wish and Create Fork.
+
+   <!-- <img src="/src/assets/git-tut-2.png"/> -->
+
+3. Once the Fork is completed, you should now see it as a repository in your personal GitHub account
+   or whatever account you chose as the owner.
+4. While on the Forked repo, clone it and perform the updates you wish to.
+
+### I forked from the wrong repo; how do I change it?
+
+If you forked from the wrong repo and you haven’t made any commits, then the easiest option is to
+start over. If you have made commits you will need to change the fork location like this...
+
+1. Fork the correct repo (the Thoth Tech one) via the GitHub web interface
+
+2. Navigate to the your local repo's root directory in terminal
+
+3. Rename your origin to upstream
+
+   git remote rename origin upstream
+
+4. Add the new fork as the origin
+
+   git remote add origin [[email protected]]([email protected])/[GITHUB_USERNAME]/[YOUR_NEW_FORK_NAME]
+
+5. Fetch from new origin
+
+   git fetch origin
+
+6. Set origin master
+
+   git branch --set-upstream-to origin/master master
+
+7. Push to fork
+
+   git push origin
+
+... Done!
+
+Your changes should now be going to the right place.
+
+## Step 2: Install Prettier, Vale, and Markdown Lint on VS Code
+
+After you have forked the repository and cloned it to begin work on your local system via VS Code,
+you would need to set up the required spell checkers and code formatters to ensure compatibility
+during code build. To achieve this, do the following.
+
+1. Locate and Click the Extensions icon on the navigation bar (usually located at the left side of
+   your screen).
+
+2. Search for Prettier and follow the prompts to install it.
+
+3. Follow the same process to search for and install Vale and Markdownlint.
+4. Navigate back to your terminal. To ensure that all the required modules is available on the copy
+   of the cloned repo, run "npm install" on the terminal.
+5. To configure Prettier, run "npm install prettier."
+6. To ensure the document is well formatted after creation, right click on your document and select
+   "Format Document with", then select "markdownlint", then right click the document again and
+   Format Document with "Prettier."
+
+## Step 3: Format your Code
+
+For a markdown document, the tools installed above would be used for this purpose. Once you are done
+writing your document, follow these steps to prevent a failed check in GitHub.
+
+1. On your document, right click and select “Format document with” and select markdwonlint.
+2. Then right click again, select “Format document with” and select Prettier.
+3. On your terminal run npm run format:check.
+
+## Step 4: Create a Commit
+
+- On VS Code, locate the commit icon on the left navigation bar, type in a Commit message (you can
+  adopt [Chris beam’s guide](https://cbea.ms/git-commit/) to create a good commit message), and
+  commit the changes.
+
+  <!-- <img src="/src/assets/git-tut-5.png"/> -->
+
+## Step 5: Create a Pull Request
+
+1. On GitHub, navigate to the main page of the repository.
+2. In the "Branch" menu, choose the branch that contains your commits.
+3. Above the list of files, in the yellow banner, click Compare & pull request to create a pull
+   request for the associated branch.
+4. Use the base branch dropdown menu to select the branch you'd like to merge your changes into,
+   then use the compare branch drop-down menu to choose the topic branch you made your changes in.
+    <!-- <img src="/src/assets/git-tut-6.png"/> -->
+5. Type a title and description for your pull request.
+6. To create a pull request that is ready for review, click Create Pull Request. To create a draft
+   pull request, use the drop-down and select Create Draft Pull Request, then click Draft Pull
+   Request.
+7. After your pull request has been reviewed and approved, it can be merged into the repository.
+
+## Code Review Guidelines
+
+You are strongly encouraged to get your code reviewed by a reviewer as soon as there is any code to
+review, to get a second opinion on the chosen solution and implementation, and an extra pair of eyes
+looking for bugs, logic problems, or uncovered edge cases.
+
+### Draft Pull Request
+
+Draft Pull Requests allow a work in progress to receive early feedback. The developer creating the
+PR should, in the description, indicate their progress and any particular aspect they are looking
+for feedback on. When the PR is ready for final review, the developer should update the description,
+re-request reviews as required and change the status to "ready to review".
+
+Pull requests (draft and otherwise) are created from the GitHub website.
+
+### Required Approvals
+
+Pull requests require **a minimum of two approvals**. The default approach is to choose a reviewer
+from your team for the first review. However, the reviewer may be from different team, for example a
+domain expert in a programming language, quality assurance process, telemetry or documentation.
+Depending on the team size and dynamics, the number of required approvals can be higher or lower.
+
+## Collaborate on an existing branch
+
+Ideally, we should avoid having developers working on the same code. It creates merge conflicts and
+hinders efficiency. If possible, try to break it down into small tasks so developers can work
+independently. In the worst-case scenario, if there is more than 1 person working on a feature
+branch:
+
+1. Please make sure you pull changes in the remote branch before starting your work.
+
+   git pull origin feature/_remote branch name_
+
+2. Resolve any merge conflicts that may now be revealed. **Please avoid force-push and rebase when
+   working on a shared branch**. It can cause complex and hard to resolve merge conflicts as wellas
+   undo others' commits accidentally.

Projects/Starlight/apparent-asteroid/src/content/docs/policies/Trello-Management-Policy.md

@@ -0,0 +1,93 @@
+---
+title: Trello Management Policy
+---
+
+## Trello Management Policy
+
+This document states the guideline every Thoth Tech employee should adopt when using Trello.
+
+### Associate all Completed Trello Cards with GitHub
+
+The purpose of this is to increase visibility of tasks done. This enables anyone who comes across a
+Trello card to navigate to the committed task on GitHub hereby enabling them to have a better
+understanding of what the Trello card entails.
+
+To associate you Trello card with a GitHub commit, follow the steps provided below.
+
+- Locate and open the Card on Trello
+
+- On the right hand side of the opened card, Click on GitHub.
+
+  ![Trello card](/images/trellocardcapture.png)
+
+- Then select "**Attach Commit**" or "**Attach Branch**" depending on your scenario. In this
+  scenario, I would attach a commit.
+
+  ![Attach commit](/images/attachcommit.png)
+
+- Select "**Choose repo**" and click on the repo containing your commits.
+
+  ![Choose repo](/images/chooserepo.png)
+
+- Choose the branch that has the completed task.
+
+  ![Choose branch](/images/choosebranch.png)
+
+- Choose the right commit from the list provided.
+
+  ![Choose commit](/images/choosecommit.png)
+
+- Your card would now look like this.
+
+  ![Final look](/images/finalcardlook.png)
+
+### Add Timelines to your Trello Card
+
+Adding a timeline to your card would enable a reviewer to easily identify if the assigned person has
+gone above the agreed timeline for executing the task. This makes it easier to identify the tasks to
+be done and prevent carry over of tasks to the next Sprint.
+
+To add a timeline to your card follow the steps below.
+
+- Locate and click on the created Trello card.
+- On the side navigation bar, select Dates.
+
+  ![Final look](/images/timeline1.png)
+
+- Tick the Start date check box and enter a start date.
+- On the Due date box, enter the date and expected time of completion.
+
+  ![Final look](/images/timeline2.png)
+
+- For "Set due date reminder," select a time of your choice, for e.g., "1 Day before" and click on
+  Save.
+- Exit the Card and now you should see the Timeline on your card.
+
+  ![Final look](/images/timeline3.png)
+
+### Use Labels to Differentiate Sprints
+
+This feature would enable team members to identify the tasks that were done in a particular Sprint.
+It would also enable those who need to gain a certain amount of story points in a Sprint to easily
+keep track of their work.
+
+A sprint is a two-week period of time during which specific tasks must be completed based on what
+the team has prioritized to deliver. Considering the trimester consists of 11 weeks, it is expected
+that there would be five sprints in a trimester.
+
+For consistency accross the organization, the following colors should be used for the Sprint labels.
+
+- Sprint 1: <span style="color: pink;">Pink</span>
+- Sprint 2: <span style="color: yellow;">Yellow</span>
+- Sprint 3: <span style="color: green;">Green</span>
+- Sprint 4: <span style="color: orange;">Orange</span>
+- Sprint 5: <span style="color: red;">Red</span>
+
+To add labels to your card, follow the steps below.
+
+- Locate and click on your Trello card.
+- From the side bar, select Labels and select the required color for the Sprint.
+- If you do not find the color you want, select "Create a new label" and type in the color of
+  choice.
+- Next, click on the pencil symbol by the right of the color and update the label name to Sprint 1
+  or whatever Sprint you are on.