Initial commit

ben-basten · Dec 11, 2023 · 0424156 · 0424156
commit 0424156
Show file tree

Hide file tree

Showing 22 changed files with 157 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+# wiki
+
+## Installation
+
+1. Check that python / pip are installed
+    ```
+    python3 --version
+    pip3 --version
+    ```
+2. `pip3 install mkdocs`
+3. `pip3 install mkdocs-material`
+4. ...and you're off to the races!
+
+## Running mkdocs
+
+**Local server**
+
+`mkdocs serve`
+
+**Build static html**
+
+`mkdocs build`
+
+Files will be built into the `site` folder, which is not checked into Git.
+
+## Helpful scripts
+
+* Generate new pattern page: `./pattern.sh "Your Pattern Title"`
+
+## Documenation
+
+* [mkdocs](https://www.mkdocs.org/user-guide/installation/)
+* [mkdocs-material theme](https://squidfunk.github.io/mkdocs-material/)
diff --git a/daily.sh b/daily.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+echo "MAKING DAILY ENTRY"
+
+DATE=$(date +%Y-%m-%d)
+WEEKLYDIRECTORY="docs/daily/week-of_${DATE}"
+
+TODAY=$(date)
+if [[ $TODAY == Mon* ]] && [ ! -d ${WEEKLYDIRECTORY} ]; then
+    mkdir $WEEKLYDIRECTORY
+    echo $WEEKLYDIRECTORY dir created
+fi
+
+ACTIVEWEEK=$(ls -l docs/daily | tail -1 | awk '{ print $10 }')
+FILENAME="docs/daily/${ACTIVEWEEK}/${DATE}-todo.md"
+
+if [ ! -f ${FILENAME} ]; then
+    # make new daily entry
+    cp templates/daily-template.md ${FILENAME}
+    # add header to daily entry
+    sed -i '' "1s/^/# ${DATE} TODO \n/" ${FILENAME}
+    echo $FILENAME created.
+fi
+
+# open in vscode editor
+code $FILENAME
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/daily/.placeholder b/docs/daily/.placeholder
diff --git a/docs/daily/README.md b/docs/daily/README.md
@@ -0,0 +1,12 @@
+# daily
+
+Keep track of daily notes, organized by week.
+
+Daily notes include:
+
+-   time in/out
+-   hours worked
+-   time off taken
+-   meetings
+-   meetings notes
+-   what tasks have been worked on and completed
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+# Welcome!
+
+Wiki to keep track of the day-to-day happenings.
diff --git a/docs/notes/.placeholder b/docs/notes/.placeholder
diff --git a/docs/notes/README.md b/docs/notes/README.md
@@ -0,0 +1,3 @@
+# notes
+
+Place to store longer-form research or meeting notes.
diff --git a/docs/patterns/.placeholder b/docs/patterns/.placeholder
diff --git a/docs/patterns/README.md b/docs/patterns/README.md
@@ -0,0 +1,3 @@
+# patterns
+
+Reusable solutions for common problems.
diff --git a/docs/resources/.placeholder b/docs/resources/.placeholder
diff --git a/docs/resources/README.md b/docs/resources/README.md
@@ -0,0 +1,3 @@
+# resources
+
+Static resources for the documentation.
diff --git a/jira.sh b/jira.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# script to replace all instances of this regex (?<!\[)(KEY-(\d){4,5})(?!\)) with [$0](https://mycompany.atlassian.net/browse/$0) in file passed as argument
+# Replace "KEY" with your Jira project key
+
+# update script to run perl command for all arguments passed to script
+for i in "$@"
+do
+  perl -pi -e 's/(?<!\[)(KEY-(\d){4,5})(?!\))/[$1](https:\/\/mycompany.atlassian.net\/browse\/$1)/g' $i
+done
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,7 @@
+site_name: wiki
+theme:
+    name: material
+    palette:
+        scheme: slate
+markdown_extensions:
+    - pymdownx.tilde
diff --git a/pattern.sh b/pattern.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# replace spaces with hyphens, make it lowercase
+filename=$(echo $1 | tr '[:upper:]' '[:lower:]' | tr ' ' '-')
+
+cp templates/pattern.md docs/patterns/${filename}.md
+
+# replace the first line of the file with the pattern name
+sed -i '' "1s/.*/# $1/" docs/patterns/${filename}.md
+
+code docs/patterns/${filename}.md
diff --git a/templates/daily-template.md b/templates/daily-template.md
@@ -0,0 +1,15 @@
+## Hours
+
+in @
+
+out @
+
+## Tasks In Progress
+
+## In Review
+
+## Releases/Completed
+
+## Meetings
+
+## Notes
diff --git a/templates/pattern.md b/templates/pattern.md
@@ -0,0 +1,9 @@
+# patternName
+
+## Forces/Conflict
+
+## Resolution
+
+## Preceding Patterns
+
+## Following Patterns
diff --git a/todo/README.md b/todo/README.md
@@ -0,0 +1,15 @@
+# todo
+
+Version control tracking for the generate [todo.txt tool](http://todotxt.org/) files.
+
+To point todo.txt to this directory, add the following to the ~/.todo.cfg file:
+
+```
+# Your todo.txt directory (this should be an absolute path)
+export TODO_DIR="/path/to/wiki/todo"
+
+# Your todo/done/report.txt locations
+export TODO_FILE="$TODO_DIR/todo.txt"
+export DONE_FILE="$TODO_DIR/done.txt"
+export REPORT_FILE="$TODO_DIR/report.txt"
+```
diff --git a/todo/done.txt b/todo/done.txt
diff --git a/todo/report.txt b/todo/report.txt
diff --git a/todo/todo.txt b/todo/todo.txt
diff --git a/weekly-hours.sh b/weekly-hours.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+ACTIVEWEEK=$(ls -l docs/daily | tail -1 | awk '{ print $10 }')
+
+echo "ADDING WEEKLY HOURS: ${ACTIVEWEEK}"
+
+awk '/hours/' docs/daily/${ACTIVEWEEK}/* | awk 'sum+=$1; END{print sum " hours total"}'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Welcome!

		Wiki to keep track of the day-to-day happenings.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# notes

		Place to store longer-form research or meeting notes.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# patterns

		Reusable solutions for common problems.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# resources

		Static resources for the documentation.