diff --git a/.gitattributes b/.gitattributes
deleted file mode 100644
index 26a7e61..0000000
--- a/.gitattributes
+++ /dev/null
@@ -1 +0,0 @@
-**/*.md -whitespace
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
new file mode 100644
index 0000000..182c845
--- /dev/null
+++ b/.github/workflows/deploy.yml
@@ -0,0 +1,43 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+ push:
+ branches:
+ - gh-pages-src
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ fetch-depth: 0 # Fetch all history for all tags and branches
+
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: '3.x'
+
+ - name: Install dependencies
+ run: |
+ git checkout gh-pages-src
+ pip install -r requirements.txt
+
+ - name: Build and deploy
+ run: |
+ mkdocs build
+ git config user.name "Juice Brenner Build Bot"
+ git config user.email "seattlecommunitynetwork.org"
+ git checkout gh-pages
+ git add --all
+ git stash
+ rm -rf *
+ git stash pop
+ mv site/* .
+ rm -r site
+ git add --all
+ git commit -m "Yet another automated deployment"
+ git push
+
+
+
diff --git a/.gitignore b/.gitignore
index 0d971d4..5ceb386 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1 @@
-_site
-.sass-cache
-.jekyll-cache
-.jekyll-metadata
-vendor
-.swp
-.DS_Store
+venv
diff --git a/.gitmodules b/.gitmodules
deleted file mode 100644
index e69de29..0000000
diff --git a/404.html b/404.html
deleted file mode 100644
index 886ad42..0000000
--- a/404.html
+++ /dev/null
@@ -1,228 +0,0 @@
----
-permalink: /404.html
-layout: default
----
-
-
-
-
-
404
- page not found
-
-
-
-
Boo, looks like a ghost stole this page!
-
-
-
diff --git a/CNAME b/CNAME
deleted file mode 100644
index 8164090..0000000
--- a/CNAME
+++ /dev/null
@@ -1 +0,0 @@
-docs.seattlecommunitynetwork.org
diff --git a/Gemfile b/Gemfile
deleted file mode 100644
index 8cb55a3..0000000
--- a/Gemfile
+++ /dev/null
@@ -1,31 +0,0 @@
-source "https://rubygems.org"
-# Hello! This is where you manage which Jekyll version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-#
-# bundle exec jekyll serve
-#
-# This will help ensure the proper Jekyll version is running.
-# Happy Jekylling!
-#gem "jekyll", "~> 4.2.0"
-# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem "just-the-docs"
-# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-# uncomment the line below. To upgrade, run `bundle update github-pages`.
-gem "github-pages", "~> 215", group: :jekyll_plugins
-# If you have any plugins, put them here!
-group :jekyll_plugins do
- gem "jekyll-feed", "~> 0.12"
-end
-
-# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
-# and associated library.
-platforms :mingw, :x64_mingw, :mswin, :jruby do
- gem "tzinfo", "~> 1.2"
- gem "tzinfo-data"
-end
-
-# Performance-booster for watching directories on Windows
-gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
-
-gem "webrick", "~> 1.7"
diff --git a/Gemfile.lock b/Gemfile.lock
deleted file mode 100644
index 28e6679..0000000
--- a/Gemfile.lock
+++ /dev/null
@@ -1,276 +0,0 @@
-GEM
- remote: https://rubygems.org/
- specs:
- activesupport (6.0.5.1)
- concurrent-ruby (~> 1.0, >= 1.0.2)
- i18n (>= 0.7, < 2)
- minitest (~> 5.1)
- tzinfo (~> 1.1)
- zeitwerk (~> 2.2, >= 2.2.2)
- addressable (2.8.1)
- public_suffix (>= 2.0.2, < 6.0)
- coffee-script (2.4.1)
- coffee-script-source
- execjs
- coffee-script-source (1.11.1)
- colorator (1.1.0)
- commonmarker (0.17.13)
- ruby-enum (~> 0.5)
- concurrent-ruby (1.1.10)
- dnsruby (1.61.9)
- simpleidn (~> 0.1)
- em-websocket (0.5.3)
- eventmachine (>= 0.12.9)
- http_parser.rb (~> 0)
- ethon (0.15.0)
- ffi (>= 1.15.0)
- eventmachine (1.2.7)
- execjs (2.8.1)
- faraday (2.5.2)
- faraday-net_http (>= 2.0, < 3.1)
- ruby2_keywords (>= 0.0.4)
- faraday-net_http (3.0.0)
- ffi (1.15.5-x64-mingw-ucrt)
- forwardable-extended (2.6.0)
- gemoji (3.0.1)
- github-pages (215)
- github-pages-health-check (= 1.17.2)
- jekyll (= 3.9.0)
- jekyll-avatar (= 0.7.0)
- jekyll-coffeescript (= 1.1.1)
- jekyll-commonmark-ghpages (= 0.1.6)
- jekyll-default-layout (= 0.1.4)
- jekyll-feed (= 0.15.1)
- jekyll-gist (= 1.5.0)
- jekyll-github-metadata (= 2.13.0)
- jekyll-mentions (= 1.6.0)
- jekyll-optional-front-matter (= 0.3.2)
- jekyll-paginate (= 1.1.0)
- jekyll-readme-index (= 0.3.0)
- jekyll-redirect-from (= 0.16.0)
- jekyll-relative-links (= 0.6.1)
- jekyll-remote-theme (= 0.4.3)
- jekyll-sass-converter (= 1.5.2)
- jekyll-seo-tag (= 2.7.1)
- jekyll-sitemap (= 1.4.0)
- jekyll-swiss (= 1.0.0)
- jekyll-theme-architect (= 0.1.1)
- jekyll-theme-cayman (= 0.1.1)
- jekyll-theme-dinky (= 0.1.1)
- jekyll-theme-hacker (= 0.1.2)
- jekyll-theme-leap-day (= 0.1.1)
- jekyll-theme-merlot (= 0.1.1)
- jekyll-theme-midnight (= 0.1.1)
- jekyll-theme-minimal (= 0.1.1)
- jekyll-theme-modernist (= 0.1.1)
- jekyll-theme-primer (= 0.5.4)
- jekyll-theme-slate (= 0.1.1)
- jekyll-theme-tactile (= 0.1.1)
- jekyll-theme-time-machine (= 0.1.1)
- jekyll-titles-from-headings (= 0.5.3)
- jemoji (= 0.12.0)
- kramdown (= 2.3.1)
- kramdown-parser-gfm (= 1.1.0)
- liquid (= 4.0.3)
- mercenary (~> 0.3)
- minima (= 2.5.1)
- nokogiri (>= 1.10.4, < 2.0)
- rouge (= 3.26.0)
- terminal-table (~> 1.4)
- github-pages-health-check (1.17.2)
- addressable (~> 2.3)
- dnsruby (~> 1.60)
- octokit (~> 4.0)
- public_suffix (>= 2.0.2, < 5.0)
- typhoeus (~> 1.3)
- html-pipeline (2.14.2)
- activesupport (>= 2)
- nokogiri (>= 1.4)
- http_parser.rb (0.8.0)
- i18n (0.9.5)
- concurrent-ruby (~> 1.0)
- jekyll (3.9.0)
- addressable (~> 2.4)
- colorator (~> 1.0)
- em-websocket (~> 0.5)
- i18n (~> 0.7)
- jekyll-sass-converter (~> 1.0)
- jekyll-watch (~> 2.0)
- kramdown (>= 1.17, < 3)
- liquid (~> 4.0)
- mercenary (~> 0.3.3)
- pathutil (~> 0.9)
- rouge (>= 1.7, < 4)
- safe_yaml (~> 1.0)
- jekyll-avatar (0.7.0)
- jekyll (>= 3.0, < 5.0)
- jekyll-coffeescript (1.1.1)
- coffee-script (~> 2.2)
- coffee-script-source (~> 1.11.1)
- jekyll-commonmark (1.3.1)
- commonmarker (~> 0.14)
- jekyll (>= 3.7, < 5.0)
- jekyll-commonmark-ghpages (0.1.6)
- commonmarker (~> 0.17.6)
- jekyll-commonmark (~> 1.2)
- rouge (>= 2.0, < 4.0)
- jekyll-default-layout (0.1.4)
- jekyll (~> 3.0)
- jekyll-feed (0.15.1)
- jekyll (>= 3.7, < 5.0)
- jekyll-gist (1.5.0)
- octokit (~> 4.2)
- jekyll-github-metadata (2.13.0)
- jekyll (>= 3.4, < 5.0)
- octokit (~> 4.0, != 4.4.0)
- jekyll-mentions (1.6.0)
- html-pipeline (~> 2.3)
- jekyll (>= 3.7, < 5.0)
- jekyll-optional-front-matter (0.3.2)
- jekyll (>= 3.0, < 5.0)
- jekyll-paginate (1.1.0)
- jekyll-readme-index (0.3.0)
- jekyll (>= 3.0, < 5.0)
- jekyll-redirect-from (0.16.0)
- jekyll (>= 3.3, < 5.0)
- jekyll-relative-links (0.6.1)
- jekyll (>= 3.3, < 5.0)
- jekyll-remote-theme (0.4.3)
- addressable (~> 2.0)
- jekyll (>= 3.5, < 5.0)
- jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
- rubyzip (>= 1.3.0, < 3.0)
- jekyll-sass-converter (1.5.2)
- sass (~> 3.4)
- jekyll-seo-tag (2.7.1)
- jekyll (>= 3.8, < 5.0)
- jekyll-sitemap (1.4.0)
- jekyll (>= 3.7, < 5.0)
- jekyll-swiss (1.0.0)
- jekyll-theme-architect (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-cayman (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-dinky (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-hacker (0.1.2)
- jekyll (> 3.5, < 5.0)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-leap-day (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-merlot (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-midnight (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-minimal (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-modernist (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-primer (0.5.4)
- jekyll (> 3.5, < 5.0)
- jekyll-github-metadata (~> 2.9)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-slate (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-tactile (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-time-machine (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-titles-from-headings (0.5.3)
- jekyll (>= 3.3, < 5.0)
- jekyll-watch (2.2.1)
- listen (~> 3.0)
- jemoji (0.12.0)
- gemoji (~> 3.0)
- html-pipeline (~> 2.2)
- jekyll (>= 3.0, < 5.0)
- just-the-docs (0.3.3)
- jekyll (>= 3.8.5)
- jekyll-seo-tag (~> 2.0)
- rake (>= 12.3.1, < 13.1.0)
- kramdown (2.3.1)
- rexml
- kramdown-parser-gfm (1.1.0)
- kramdown (~> 2.0)
- liquid (4.0.3)
- listen (3.7.1)
- rb-fsevent (~> 0.10, >= 0.10.3)
- rb-inotify (~> 0.9, >= 0.9.10)
- mercenary (0.3.6)
- minima (2.5.1)
- jekyll (>= 3.5, < 5.0)
- jekyll-feed (~> 0.9)
- jekyll-seo-tag (~> 2.1)
- minitest (5.16.3)
- nokogiri (1.13.8-x64-mingw-ucrt)
- racc (~> 1.4)
- octokit (4.25.1)
- faraday (>= 1, < 3)
- sawyer (~> 0.9)
- pathutil (0.16.2)
- forwardable-extended (~> 2.6)
- public_suffix (4.0.7)
- racc (1.6.0)
- rake (13.0.6)
- rb-fsevent (0.11.2)
- rb-inotify (0.10.1)
- ffi (~> 1.0)
- rexml (3.2.5)
- rouge (3.26.0)
- ruby-enum (0.9.0)
- i18n
- ruby2_keywords (0.0.5)
- rubyzip (2.3.2)
- safe_yaml (1.0.5)
- sass (3.7.4)
- sass-listen (~> 4.0.0)
- sass-listen (4.0.0)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- sawyer (0.9.2)
- addressable (>= 2.3.5)
- faraday (>= 0.17.3, < 3)
- simpleidn (0.2.1)
- unf (~> 0.1.4)
- terminal-table (1.8.0)
- unicode-display_width (~> 1.1, >= 1.1.1)
- thread_safe (0.3.6)
- typhoeus (1.4.0)
- ethon (>= 0.9.0)
- tzinfo (1.2.10)
- thread_safe (~> 0.1)
- tzinfo-data (1.2022.3)
- tzinfo (>= 1.0.0)
- unf (0.1.4)
- unf_ext
- unf_ext (0.0.8.2-x64-mingw-ucrt)
- unicode-display_width (1.8.0)
- wdm (0.1.1)
- webrick (1.7.0)
- zeitwerk (2.6.0)
-
-PLATFORMS
- x64-mingw-ucrt
-
-DEPENDENCIES
- github-pages (~> 215)
- jekyll-feed (~> 0.12)
- just-the-docs
- tzinfo (~> 1.2)
- tzinfo-data
- wdm (~> 0.1.1)
- webrick (~> 1.7)
-
-BUNDLED WITH
- 2.3.21
diff --git a/README.md b/README.md
deleted file mode 100644
index e5e75cf..0000000
--- a/README.md
+++ /dev/null
@@ -1,4 +0,0 @@
-# SCN Docs
-This repository contains the contents of the [Seattle Community Network Docs](https://docs.seattlecommunitynetwork.org/). It is intended to provide interested community members a guidebook on how to get involved in the community and learn.
-
-To learn how to contribute to these docs, visit our documentation on that [here](https://docs.seattlecommunitynetwork.org/contribute.html).
diff --git a/_config.yml b/_config.yml
deleted file mode 100644
index d43e461..0000000
--- a/_config.yml
+++ /dev/null
@@ -1,61 +0,0 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-#
-# If you need help with YAML syntax, here are some quick references for you:
-# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
-# https://learnxinyminutes.com/docs/yaml/
-#
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
-
-title: Seattle Community Network Docs
-email: lcl@seattlecommunitynetwork.org
-description: >- # this means to ignore newlines until "baseurl:"
- Hub of information for all things related to Seattle Community Network.
-#baseurl: "/docs" # the subpath of your site, e.g. /blog
-url: "https://docs.seattlecommunitynetwork.org" # the base hostname & protocol for your site, e.g. http://example.com
-twitter_username: SeattleCommNet
-github_username: Local-Connectivity-Lab
-
-# Build settings
-remote_theme: pmarsceill/just-the-docs
-#plugins:
-# - jekyll-feed
-
-# Footer "Edit this page on GitHub" link text
-gh_edit_link: true # show or hide edit this page link
-gh_edit_link_text: "Edit this page on GitHub"
-gh_edit_repository: "https://github.com/Local-Connectivity-Lab/scn-documentation" # the github URL for your repo
-gh_edit_branch: "gh-pages" # the branch that your docs is served from
-# gh_edit_source: docs # the source that your files originate from
-gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
-
-# Exclude from processing.
-# The following items will not be processed, by default.
-# Any item listed under the `exclude:` key here will be automatically added to
-# the internal "default list".
-#
-# Excluded items can be processed by explicitly listing the directories or
-# their entries' file path in the `include:` list.
-#
-# exclude:
-# - .sass-cache/
-# - .jekyll-cache/
-# - gemfiles/
-# - Gemfile
-# - Gemfile.lock
-# - node_modules/
-# - vendor/bundle/
-# - vendor/cache/
-# - vendor/gems/
-# - vendor/ruby/
diff --git a/_posts/2021-05-15-welcome-to-jekyll.markdown b/_posts/2021-05-15-welcome-to-jekyll.markdown
deleted file mode 100644
index a9ec2b8..0000000
--- a/_posts/2021-05-15-welcome-to-jekyll.markdown
+++ /dev/null
@@ -1,29 +0,0 @@
----
-layout: post
-title: "Welcome to Jekyll!"
-date: 2021-05-15 10:27:12 -0700
-categories: jekyll update
----
-You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
-
-Jekyll requires blog post files to be named according to the following format:
-
-`YEAR-MONTH-DAY-title.MARKUP`
-
-Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.
-
-Jekyll also offers powerful support for code snippets:
-
-{% highlight ruby %}
-def print_hi(name)
- puts "Hi, #{name}"
-end
-print_hi('Tom')
-#=> prints 'Hi, Tom' to STDOUT.
-{% endhighlight %}
-
-Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
-
-[jekyll-docs]: https://jekyllrb.com/docs/home
-[jekyll-gh]: https://github.com/jekyll/jekyll
-[jekyll-talk]: https://talk.jekyllrb.com/
diff --git a/community/index.md b/community/index.md
deleted file mode 100644
index 612ea53..0000000
--- a/community/index.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: Community
-nav_order: 4
-has_children: true
----
-
-# Community
-Learn more about our community here!
diff --git a/contribute.md b/contribute.md
deleted file mode 100644
index 6e2e80f..0000000
--- a/contribute.md
+++ /dev/null
@@ -1,120 +0,0 @@
----
-title: Contribute to SCN Docs
----
-
-# Contribute to SCN Docs
-
-## Looking to help?
-
-If you wanna share resources and help improve our docs, this page will get you started!
-Our docs are designed so that anyone can contribute. If this page isn't enough, contact one of
-us and we'll be able to help you!
-
-Our documentation uses the [Just the Docs](https://pmarsceill.github.io/just-the-docs/) Jekyll theme.
-This theme provides a lot of nice features, so look there for help too!
-
-## Editing process
-To edit this documentation you should:
-1. Get your own copy of the [repo](https://github.com/Local-Connectivity-Lab/scn-documentation)
-2. Modify the documentation in your own repo (for more information see section on Local Development)
-3. Submit a pull request
-4. Wait for someone to review and accept the request
-
-The rest of this page will explain all the details you need to know about the directory structure, markdown, and other quirks for editing this documentation. Make sure to read everything!
-
-**PRO TIP**{: .label .label-green } If you want to quickly edit a page, you can scroll to the bottom of the page and click "Edit this page on GitHub". Clicking the pencil button on that page will automatically send you to your own fork, allow you to make edits, and you can make a pull request from there.
-
-## Markdown files
-All our documentation is stored in 'Markdown' files so that they can be easily
-modified and changed without heavy technical knowledge.
-
-### Markdown Editors
-
-- A nice and simple online editor is [StackEdit](https://stackedit.io/app#) which will let you type in markdown and see what it would look like in realtime in split-screen.
-
-- Another option is [HackMD](https://hackmd.io/) which has the same features as StackEdit
-but it also allows you to connect to your own GitHub repo and pull/push.
- - This is a nice option if you are uncomfortable with using Git from the command line.
-
-## Local Development
-
-### Using Jekyll
-The best workflow for editing our documentation is to get Jekyll installed on your computer so that you can dynamically generate this website and see your changes on your own computer. The only downside is that it requires some set-up, but once everything is setup everything should be smooth!
-
-You must have Jekyll installed (instructions for your respective OS can be found [here](https://jekyllrb.com/docs/installation/)).
-
-After you have Jekyll installed, you can start up a local web server by running the command `bundle exec jekyll serve` in the main directory of this repo on your computer. This should spin up a webserver at http://localhost:4000/ and you can make edits to files and refresh your page to see the changes.
-
-Once you're satisfied with your changes, make sure all your changes are committed to your repo and submit a pull request!
-
-### Avoiding Jekyll
-If you're planning on just making small edits to markdown files, then you don't _**have**_ to install Jekyll to make changes. You can simply edit markdown files, push it to your repo, and preview your changes in the github page for your respective repo (GitHub should automatically deploy it for you with a personalized link) If you're satisfied with these changes, go ahead with submitting a pull request!
-
-### A Note on GitHub Deployments
-The best way to preview what the website will look like is to use Jekyll and see what it looks like on the localhost webserver.
-
-However, if you push changes to your local repo, GitHub will automatically deploy a version of the page and give you apersonalized link. This deployment will not be accurate because you need to change the "url" in \_config.yml to reflecet the personalized link for your github repo. If you don't, all the links and assets will point to stuff from docs.seattlecommunitynetwork.org.
-
-## Documentation Directory Structure
-
-### Top-level pages
-An example of a 'top-level page' would be the 'Get Started' page.
-The 'Get Started' page is located in the top-level directory inside the markdown file
-'get-started.md'. Note that the file name doesn't affect anything but the page's name
-in the URL (get-started.html). Everything else is controlled by the stuff inside
-the 'YAML Front Matter' of the markdown file.
-
-Here is the YAML front matter for 'Get Started':
-```yaml
----
-title: Get Started
-nav_order: 2
----
-```
-
-- The title represents the display name of the page and is important for connecting it with other pages.
-- The nav_order dictates that this page is the 2nd from the top in the sidebar.
-
-### Parent pages
-An example of a 'parent page' would be the 'Learn' page.
-The 'Learn' page is located in the learn directory as 'learn/index.md'.
-Note that the 'Learn' page is almost the same as a top-level page, except it has children pages.
-
-Here is the YAML front matter for 'Learn'
-```yaml
----
-title: Learn
-nav_order: 4
-has_children: true
----
-```
-
-- The 'title' represents the display name of this page and is also what the children
-pages will use to reference this page as their parent.
-- The 'has_children' is what dictates 'Learn' to be a parent page.
-
-### Children pages
-An example of a 'children page' would be the 'Wireless Communication' page inside the learn directory as 'learn/wireless-communication.md'.
-
-Here is the YAML front matter for 'Wireless Communication':
-```yaml
----
-title: Wireless Communication
-parent: Learn
-nav_order: 1
----
-```
-
-- The 'parent' is used to mark the 'Learn' page as a parent, which causes this page to
-appear underneath 'Learn' as a dropdown page.
-- The 'nav_order' is used to enforce that this page occurs as the first page underneath 'Learn'
-
-## Static Files
-
-If you need static files for any of your pages, you should put them in the "assets" folder underneath an appropriate folder.
-
-For example, for the cable-crimping page, the images for the tutorial are located in the "assets/cable-crimping" folder. These images can then be referenced with the following standard markdown image syntax:
-```markdown
-{% raw %} ![RJ45 Crimping Tool]({{site.url}}/assets/cable-crimping/kit-crimping-tool.jpg) {% endraw %}
-```
-**NOTE**{: .label .label-green} Notice the use of site.url with the curly braces. This is 'Liquid' syntax that is used by Jekyll to dynamically generate the base url. This should be docs.seattlecommunitynetwork.org in production, but will be localhost:4000 when ran locally with `bundle exec jekyll serve`.
diff --git a/docs/.pages b/docs/.pages
new file mode 100644
index 0000000..d3eb4bd
--- /dev/null
+++ b/docs/.pages
@@ -0,0 +1,7 @@
+nav:
+ - index.md
+ - faq
+ - community
+ - learn
+ - infrastructure
+ - contribute
\ No newline at end of file
diff --git a/docs/CNAME b/docs/CNAME
new file mode 100644
index 0000000..5e5716f
--- /dev/null
+++ b/docs/CNAME
@@ -0,0 +1 @@
+docs.seattlecommunitynetwork.org
\ No newline at end of file
diff --git a/assets/.DS_Store b/docs/assets/.DS_Store
similarity index 100%
rename from assets/.DS_Store
rename to docs/assets/.DS_Store
diff --git a/assets/cable-crimping/.DS_Store b/docs/assets/cable-crimping/.DS_Store
similarity index 100%
rename from assets/cable-crimping/.DS_Store
rename to docs/assets/cable-crimping/.DS_Store
diff --git a/assets/cable-crimping/0-boots.jpg b/docs/assets/cable-crimping/0-boots.jpg
similarity index 100%
rename from assets/cable-crimping/0-boots.jpg
rename to docs/assets/cable-crimping/0-boots.jpg
diff --git a/assets/cable-crimping/1-strip.png b/docs/assets/cable-crimping/1-strip.png
similarity index 100%
rename from assets/cable-crimping/1-strip.png
rename to docs/assets/cable-crimping/1-strip.png
diff --git a/assets/cable-crimping/2.1-untwist.png b/docs/assets/cable-crimping/2.1-untwist.png
similarity index 100%
rename from assets/cable-crimping/2.1-untwist.png
rename to docs/assets/cable-crimping/2.1-untwist.png
diff --git a/assets/cable-crimping/2.3-color-diagram.png b/docs/assets/cable-crimping/2.3-color-diagram.png
similarity index 100%
rename from assets/cable-crimping/2.3-color-diagram.png
rename to docs/assets/cable-crimping/2.3-color-diagram.png
diff --git a/assets/cable-crimping/2.3-ordered.png b/docs/assets/cable-crimping/2.3-ordered.png
similarity index 100%
rename from assets/cable-crimping/2.3-ordered.png
rename to docs/assets/cable-crimping/2.3-ordered.png
diff --git a/assets/cable-crimping/2.4-trim.png b/docs/assets/cable-crimping/2.4-trim.png
similarity index 100%
rename from assets/cable-crimping/2.4-trim.png
rename to docs/assets/cable-crimping/2.4-trim.png
diff --git a/assets/cable-crimping/3-diagram.png b/docs/assets/cable-crimping/3-diagram.png
similarity index 100%
rename from assets/cable-crimping/3-diagram.png
rename to docs/assets/cable-crimping/3-diagram.png
diff --git a/assets/cable-crimping/4-crimp.png b/docs/assets/cable-crimping/4-crimp.png
similarity index 100%
rename from assets/cable-crimping/4-crimp.png
rename to docs/assets/cable-crimping/4-crimp.png
diff --git a/assets/cable-crimping/5-test.png b/docs/assets/cable-crimping/5-test.png
similarity index 100%
rename from assets/cable-crimping/5-test.png
rename to docs/assets/cable-crimping/5-test.png
diff --git a/assets/cable-crimping/kit-cable-stripper.jpg b/docs/assets/cable-crimping/kit-cable-stripper.jpg
similarity index 100%
rename from assets/cable-crimping/kit-cable-stripper.jpg
rename to docs/assets/cable-crimping/kit-cable-stripper.jpg
diff --git a/assets/cable-crimping/kit-cable-tester.jpg b/docs/assets/cable-crimping/kit-cable-tester.jpg
similarity index 100%
rename from assets/cable-crimping/kit-cable-tester.jpg
rename to docs/assets/cable-crimping/kit-cable-tester.jpg
diff --git a/assets/cable-crimping/kit-crimping-tool.jpg b/docs/assets/cable-crimping/kit-crimping-tool.jpg
similarity index 100%
rename from assets/cable-crimping/kit-crimping-tool.jpg
rename to docs/assets/cable-crimping/kit-crimping-tool.jpg
diff --git a/assets/cable-crimping/kit-rj45-boot.jpg b/docs/assets/cable-crimping/kit-rj45-boot.jpg
similarity index 100%
rename from assets/cable-crimping/kit-rj45-boot.jpg
rename to docs/assets/cable-crimping/kit-rj45-boot.jpg
diff --git a/assets/cable-crimping/kit-rj45-connector.jpg b/docs/assets/cable-crimping/kit-rj45-connector.jpg
similarity index 100%
rename from assets/cable-crimping/kit-rj45-connector.jpg
rename to docs/assets/cable-crimping/kit-rj45-connector.jpg
diff --git a/assets/images/suzallo.jpg b/docs/assets/images/suzallo.jpg
similarity index 100%
rename from assets/images/suzallo.jpg
rename to docs/assets/images/suzallo.jpg
diff --git a/docs/community/.pages b/docs/community/.pages
new file mode 100644
index 0000000..2c97e6b
--- /dev/null
+++ b/docs/community/.pages
@@ -0,0 +1,8 @@
+nav:
+ - join.md
+ - mission-vision-values.md
+ - code-of-conduct.md
+ - join.md
+ - partners.md
+ - tech-help.md
+ - community-networking-toolkit.md
\ No newline at end of file
diff --git a/community/code-of-conduct.md b/docs/community/code-of-conduct.md
similarity index 99%
rename from community/code-of-conduct.md
rename to docs/community/code-of-conduct.md
index 16aa819..0d9fd31 100644
--- a/community/code-of-conduct.md
+++ b/docs/community/code-of-conduct.md
@@ -1,7 +1,5 @@
---
title: Code of Conduct
-parent: Community
-nav_order: 3
---
# Code of Conduct
diff --git a/community/community-networking-toolkit.md b/docs/community/community-networking-toolkit.md
similarity index 99%
rename from community/community-networking-toolkit.md
rename to docs/community/community-networking-toolkit.md
index d52f28e..4b3b96f 100644
--- a/community/community-networking-toolkit.md
+++ b/docs/community/community-networking-toolkit.md
@@ -1,7 +1,5 @@
---
title: Community Networking Toolkit
-parent: Community
-nav_order: 7
---
# Community Networking Toolkit
diff --git a/community/join.md b/docs/community/join.md
similarity index 92%
rename from community/join.md
rename to docs/community/join.md
index f20fdba..11b33f2 100644
--- a/community/join.md
+++ b/docs/community/join.md
@@ -1,7 +1,5 @@
---
title: Join Us
-parent: Community
-nav_order: 1
---
# Join Us
@@ -9,7 +7,7 @@ Seattle Community Network has a place for **everyone**. Whether you'd like to jo
to get free Internet, get involved to help out your community, learn some skills
so that you can get a job, or all of the above!
-**PRO TIP**{: .label .label-green} Do everything on this page! Our community is spread out in a lot of different places, so doing everything is the best way to make sure you don't miss out.
+**PRO TIP** Do everything on this page! Our community is spread out in a lot of different places, so doing everything is the best way to make sure you don't miss out.
## Join our Discord!
Discord is a messaging platform that we use to stay in touch
@@ -31,6 +29,7 @@ On our Google calendar we post regular occurring meetings and any impromptu even
This is one of the only places to find out about the meetings our various teams are having!
Join using one of these options:
+
- Use this [link](https://calendar.google.com/calendar/u/1?cid=Y19hMWhjOXVwMTBjOWs2YTNnNmYyb20zN2c2b0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) that should prompt you to add the calendar to your Google account
- Use this [ICS file](https://calendar.google.com/calendar/ical/c_a1hc9up10c9k6a3g6f2om37g6o%40group.calendar.google.com/public/basic.ics) to manually add the calendar via the iCalendar format.
- View the calendar [here](https://calendar.google.com/calendar/u/0/embed?src=c_a1hc9up10c9k6a3g6f2om37g6o@group.calendar.google.com&ctz=America/Los_Angeles)
diff --git a/community/mission-vision-values.md b/docs/community/mission-vision-values.md
similarity index 97%
rename from community/mission-vision-values.md
rename to docs/community/mission-vision-values.md
index 5233b17..a04f6bd 100644
--- a/community/mission-vision-values.md
+++ b/docs/community/mission-vision-values.md
@@ -1,7 +1,5 @@
---
title: Mission, Vision, Values
-parent: Community
-nav_order: 2
---
# Mission, Vision, and Values
diff --git a/community/partners.md b/docs/community/partners.md
similarity index 92%
rename from community/partners.md
rename to docs/community/partners.md
index 35466f3..c9bc415 100644
--- a/community/partners.md
+++ b/docs/community/partners.md
@@ -1,7 +1,5 @@
---
title: Our Partners
-parent: Community
-nav_order: 5
---
# Our Partners
diff --git a/community/teams.md b/docs/community/teams.md
similarity index 99%
rename from community/teams.md
rename to docs/community/teams.md
index c5fdb0b..a5035ff 100644
--- a/community/teams.md
+++ b/docs/community/teams.md
@@ -1,7 +1,5 @@
---
title: Join a Team
-parent: Community
-nav_order: 4
---
# Join a Team
@@ -15,12 +13,14 @@ Feel free to have informational meetings with the respective team leads to learn
Our outreach team is responsible for finding new site host partners, finding users, and maintaining communications with our current partners. Message the [#outreach](https://discord.gg/mneaSskFT3) channel in Discord and contact Esther Jang to learn more about how you can get involved.
This is the perfect team for you if any of the following apply to you:
+
- Experience with community organizing
- Have community connections in the Greater Seattle Area
- Have cultural humility and experience partnering with marginalized communities
- Have the ability to translate and/or interpret into non-English languages common in the Seattle area such as Spanish, Vietnamese, Somali, Oromo, Khmer, and more.
**As of July 2021, the primary objective** of the outreach team is to get connected with users for our network sites that fit any of the following criteria:
+
- Unemployed
- Seniors
- Housing-unstable or houseless
@@ -39,6 +39,7 @@ You should join this team if you have experience in or are interested in practic
Our web development team is working on redesigning and developing our new website. Message the [#website](https://discord.gg/mneaSskFT3) channel in Discord to learn more about how you can get involved.
You should join this team if you have experience in or are interested in learning any of the following skills/technologies:
+
- HTML/CSS
- Javascript
- Bootstrap
@@ -52,6 +53,7 @@ Our mobile app development team is currently developing an Android app to record
Message the [#measurement](https://discord.gg/mneaSskFT3) channel in Discord and contact Zhennan Zhou to learn more about how you can get involved.
You should join this team if you have experience in or are interested in learning any of the following skills/technologies:
+
- Android app development
- iOS app development
- Java
@@ -62,6 +64,7 @@ You should join this team if you have experience in or are interested in learnin
Our education team plays a core role in our community networks as they enable our networks to be community-owned and operated. The education team is responsible for developing educational materials, running workshops, and teaching our Digital Steward cohorts. Message the [#digital-stewards](https://discord.gg/mneaSskFT3) channel in Discord and contact Esther Jang to learn more about how you can get involved.
You should join this team if you have experience in or are interested in learning any of the following skills/technologies:
+
- Teaching
- Curriculum development
- Computer networks, LTE networks, and community networks
diff --git a/community/tech-help.md b/docs/community/tech-help.md
similarity index 99%
rename from community/tech-help.md
rename to docs/community/tech-help.md
index edd4b5a..cddbd74 100644
--- a/community/tech-help.md
+++ b/docs/community/tech-help.md
@@ -1,7 +1,5 @@
---
title: Community Tech Help
-parent: Community
-nav_order: 6
---
# Community Tech Help
diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md
new file mode 100644
index 0000000..098ec37
--- /dev/null
+++ b/docs/contribute/contribute.md
@@ -0,0 +1,53 @@
+---
+title: Contribute to SCN Docs
+---
+
+# Contribute to SCN Docs
+
+## Looking to help?
+
+If you wanna share resources and help improve our docs, this page will get you started!
+Our docs are designed so that anyone can contribute. If this page isn't enough, contact one of
+us and we'll be able to help you!
+
+Our documentation uses MkDocs ReadTheDocs theme (links at the bottom of the page)
+
+## Editing process
+To edit this documentation you should:
+
+1. Get your own copy of the [repo](https://github.com/Local-Connectivity-Lab/scn-documentation)
+1. Modify the documentation in your own repo (for more information see section on Local Development)
+1. Submit a pull request
+1. Wait for someone to review and accept the request
+
+The rest of this page will explain all the details you need to know about the directory structure, markdown, and other quirks for editing this documentation. Make sure to read everything!
+
+## Markdown files
+All our documentation is stored in 'Markdown' files so that they can be easily
+modified and changed without heavy technical knowledge.
+
+### Markdown Editors
+
+- A nice and simple online editor is [StackEdit](https://stackedit.io/app#) which will let you type in markdown and see what it would look like in realtime in split-screen.
+
+- Another option is [HackMD](https://hackmd.io/) which has the same features as StackEdit
+but it also allows you to connect to your own GitHub repo and pull/push.
+ - This is a nice option if you are uncomfortable with using Git from the command line.
+
+## Local Development
+
+### Using MkDocs
+[MkDocs](https://www.mkdocs.org/) is pretty simple, just install it through pip then you can run `mkdocs serve` to locally view the website it will generate.
+
+## Documentation Directory Structure
+Each directory has a `.site` file that declares the order each file/folder in that directory will show up.
+Children pages are implicit in the directory structure
+
+## Static Files
+
+If you need static files for any of your pages, you should put them in the `assets` folder within the top level `docs` folder
+
+For example, for the cable-crimping page, the images for the tutorial are located in the "assets/cable-crimping" folder. These images can then be referenced relatively with the following standard markdown image syntax:
+```markdown
+![RJ45 Crimping Tool](../assets/cable-crimping/kit-crimping-tool.jpg)
+```
diff --git a/docs/faq/.pages b/docs/faq/.pages
new file mode 100644
index 0000000..f1d4443
--- /dev/null
+++ b/docs/faq/.pages
@@ -0,0 +1,10 @@
+nav:
+ - connection.md
+ - what.md
+ - why.md
+ - about.md
+ - how.md
+ - site.md
+ - help.md
+
+
diff --git a/faq/about.md b/docs/faq/about.md
similarity index 71%
rename from faq/about.md
rename to docs/faq/about.md
index fde8a02..665fb3e 100644
--- a/faq/about.md
+++ b/docs/faq/about.md
@@ -1,11 +1,9 @@
---
title: What is the Seattle Community Network?
-parent: FAQ
-nav_order: 4
---
# About Seattle Community Network
Seattle Community Network (SCN) is a community network dedicated to providing fair access to underserved communities all across the Puget Sound. SCN is a project of Local Connectivity Lab, a 501(c)(3) registered non-profit that works to share free or low-cost broadband access in higher-need areas throughout the Puget Sound region, making use of existing network infrastructure such as buildings and fiber-optic cables to extend coverage to more people.
-As a community network, we rely on the help of local residents such as yourself to maintain and grow the network. [Joining us]({{site.url}}/community/join.html) is a great way to become an active member of your own community, make friends, and learn valuable technical skills.
+As a community network, we rely on the help of local residents such as yourself to maintain and grow the network. [Joining us](../community/join.md) is a great way to become an active member of your own community, make friends, and learn valuable technical skills.
diff --git a/faq/connection.md b/docs/faq/connection.md
similarity index 96%
rename from faq/connection.md
rename to docs/faq/connection.md
index 732aeac..d93b7b5 100644
--- a/faq/connection.md
+++ b/docs/faq/connection.md
@@ -1,7 +1,5 @@
---
title: How do I get Internet?
-parent: FAQ
-nav_order: 1
---
# How do I get Internet from the Seattle Community Network?
diff --git a/faq/help.md b/docs/faq/help.md
similarity index 59%
rename from faq/help.md
rename to docs/faq/help.md
index 10a6951..9dc2e22 100644
--- a/faq/help.md
+++ b/docs/faq/help.md
@@ -1,7 +1,5 @@
---
title: How can I Help?
-parent: FAQ
-nav_order: 7
---
# How can I Help?
@@ -10,6 +8,6 @@ nav_order: 7
SCN is run completely by volunteers. There are many ways you can help, and no technology skills are required. We need help with everything from setting up network hardware and developing software to community outreach and fundraising. If you want to help, we can use your talents!
-First, make sure you [get connected with our community]({{site.url}}/community/join.html).
+First, make sure you [get connected with our community](../community/join.md).
-Next, why not [Join a Team]({{site.url}}/community/teams.html) or [Contribute to SCN Docs]({{site.url}}/contribute.html)?
\ No newline at end of file
+Next, why not [Join a Team](../community/teams.md) or [Contribute to SCN Docs](../contribute/contribute.md)?
\ No newline at end of file
diff --git a/faq/how.md b/docs/faq/how.md
similarity index 91%
rename from faq/how.md
rename to docs/faq/how.md
index b3ce609..16fefdf 100644
--- a/faq/how.md
+++ b/docs/faq/how.md
@@ -1,7 +1,5 @@
---
title: How does SCN Work?
-parent: FAQ
-nav_order: 5
---
# How Does the Seattle Community Network Work?
@@ -10,4 +8,4 @@ The Seattle Community Network partners with the University of Washington to shar
The Seattle Community Network (SCN) is a wireless Internet access network using 4G LTE and WiFi technologies, providing public access from partner locations such as libraries, schools, businesses, and community centers. The Internet connection at these sites is shared wirelessly to nearby devices using the 4G LTE (cell-phone) data standard, which can be used by certain phones and hotspots (also known as Customer Premises Equipment or CPE). Individual users can connect to this signal using SCN-provided (or other compatible) devices to create a local WiFi network in their home. Some of our installed sites utilize a portion of the University of Washington's internet bandwidth, sharing it out to further neighborhoods via point-to-point wireless links. Some sites use other upstream internet service providers (ISPs) such as Lumen.
-The network is completely created, managed, and maintained by volunteers with a range of diverse skills in information technology and beyond. All infrastructure is paid for by generous donations from sponsors and the public. Speaking of which, why not [volunteer]({{site.url}}/community/join.html) or [donate](https://seattlecommunitynetwork.org/donate.html)?
\ No newline at end of file
+The network is completely created, managed, and maintained by volunteers with a range of diverse skills in information technology and beyond. All infrastructure is paid for by generous donations from sponsors and the public. Speaking of which, why not [volunteer](../community/join.md) or [donate](https://seattlecommunitynetwork.org/donate.html)?
\ No newline at end of file
diff --git a/faq/site.md b/docs/faq/site.md
similarity index 84%
rename from faq/site.md
rename to docs/faq/site.md
index e704204..fc8c695 100644
--- a/faq/site.md
+++ b/docs/faq/site.md
@@ -1,12 +1,10 @@
---
title: What is this site?
-parent: FAQ
-nav_order: 6
---
# About This Website
The Seattle Community Network Docs website is the central hub for information about our community and networks. Here, we describe our infrastructure, how to set-up hardware and software, how you can start your own community network, our community rules, and more.
-This website is maintained by our volunteers, much like the rest of our services. This means you can help us improve it by adding missing information, clarifying confusing points, or even just fixing typos you notice while you’re reading. See [Contribute to SCN Docs]({{site.url}}/contribute.html) to learn more about how you can contribute to this website.
+This website is maintained by our volunteers, much like the rest of our services. This means you can help us improve it by adding missing information, clarifying confusing points, or even just fixing typos you notice while you’re reading. See [Contribute to SCN Docs](../contribute/contribute.md) to learn more about how you can contribute to this website.
If you are looking for our main website, it is located at [www.seattlecommunitynetwork.org](https://www.seattlecommunitynetwork.org).
\ No newline at end of file
diff --git a/faq/what.md b/docs/faq/what.md
similarity index 96%
rename from faq/what.md
rename to docs/faq/what.md
index 80bf8b2..c2841c8 100644
--- a/faq/what.md
+++ b/docs/faq/what.md
@@ -1,7 +1,5 @@
---
title: What is a Community Network?
-parent: FAQ
-nav_order: 2
---
# What is a Community Network?
diff --git a/faq/why.md b/docs/faq/why.md
similarity index 97%
rename from faq/why.md
rename to docs/faq/why.md
index 41c0540..9872c30 100644
--- a/faq/why.md
+++ b/docs/faq/why.md
@@ -1,7 +1,5 @@
---
title: Why have a Community Network?
-parent: FAQ
-nav_order: 3
---
# Why Have a Community Network?
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..673ad65
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,22 @@
+---
+title: Home
+---
+
+# Seattle Community Network Docs
+Welcome to the documentation website for the [Seattle Community Network](https://seattlecommunitynetwork.org/)! If you're looking for our main website, it is located at [https://www.seattlecommunitynetwork.org](https://seattlecommunitynetwork.org/).
+
+## You're in the Right Place
+
+Seattle Community Network has a place for **everyone**. Whether you'd like to join
+to [get free Internet](faq/connection.md), get involved to help out your community, learn some skills
+so that you can get a job, or all of the above!
+
+**PRO TIP** We are a **community**. It's in our name! So, why not start by [joining our community](community/join.md)? It's easy.
+
+## What's here?
+Some topics you can find on this website include:
+
+- FAQ - get the answers to some common questions.
+- Community - get involved and learn more about our community, our rules, and what we're up to.
+- Learn - gain some new skills that you can use to help out with our networks.
+- Infrastructure - get the details on how our networks work behind the scenes.
\ No newline at end of file
diff --git a/docs/infrastructure/.pages b/docs/infrastructure/.pages
new file mode 100644
index 0000000..37c8ff6
--- /dev/null
+++ b/docs/infrastructure/.pages
@@ -0,0 +1,9 @@
+nav:
+ - hardware.md
+ - software.md
+ - peering.md
+ - librenms-manager-setup.md
+ - librenms-setup.md
+ - epc-setup.md
+ - sas-setup.md
+ - proxmox-vaultwarden-deployment.md
\ No newline at end of file
diff --git a/infrastructure/epc-setup.md b/docs/infrastructure/epc-setup.md
similarity index 94%
rename from infrastructure/epc-setup.md
rename to docs/infrastructure/epc-setup.md
index ab673ef..292c4e2 100644
--- a/infrastructure/epc-setup.md
+++ b/docs/infrastructure/epc-setup.md
@@ -1,6 +1,5 @@
---
title: Step 1. LTE Core Network Setup
-parent: Infrastructure
---
# Step 1: CoLTE/EPC (LTE Core Network) Setup
diff --git a/infrastructure/hardware.md b/docs/infrastructure/hardware.md
similarity index 97%
rename from infrastructure/hardware.md
rename to docs/infrastructure/hardware.md
index 4007690..3fa73ec 100644
--- a/infrastructure/hardware.md
+++ b/docs/infrastructure/hardware.md
@@ -1,7 +1,5 @@
---
title: Hardware Overview
-parent: Infrastructure
-nav_order: 1
---
# Our Hardware
@@ -10,7 +8,7 @@ This page will be an overview of some of the core pieces of hardware that we use
This page is in development, please contact us at lcl@seattlecommunitynetwork.org if you would like to learn more about the hardware we use.
-**TODO**{: .label .label-yellow}
+**TODO**
=======
## Network Site Equipment
diff --git a/infrastructure/librenms-manager-setup.md b/docs/infrastructure/librenms-manager-setup.md
similarity index 99%
rename from infrastructure/librenms-manager-setup.md
rename to docs/infrastructure/librenms-manager-setup.md
index 27518a3..c59f013 100644
--- a/infrastructure/librenms-manager-setup.md
+++ b/docs/infrastructure/librenms-manager-setup.md
@@ -1,6 +1,5 @@
---
title: Network Monitoring 1. LibreNMS Network Manager Configuration
-parent: Infrastructure
---
# LibreNMS Network Manager Configuration
diff --git a/infrastructure/librenms-setup.md b/docs/infrastructure/librenms-setup.md
similarity index 99%
rename from infrastructure/librenms-setup.md
rename to docs/infrastructure/librenms-setup.md
index c62ada7..c3cac96 100644
--- a/infrastructure/librenms-setup.md
+++ b/docs/infrastructure/librenms-setup.md
@@ -1,6 +1,5 @@
---
title: Network Monitoring 2. LibreNMS Agent Configuration
-parent: Infrastructure
---
# LibreNMS Agent Configuration
diff --git a/infrastructure/peering.md b/docs/infrastructure/peering.md
similarity index 93%
rename from infrastructure/peering.md
rename to docs/infrastructure/peering.md
index c50ed06..02d7318 100644
--- a/infrastructure/peering.md
+++ b/docs/infrastructure/peering.md
@@ -1,7 +1,5 @@
---
title: Public ASN Peering
-parent: Infrastructure
-nav_order: 3
---
# Public ASN Peering
### Local Connectivity Lab operates **AS54429**
@@ -12,7 +10,7 @@ Please [contact us](mailto:lcl@seattlecommunitynetwork.org) to peer with our net
Note this network is our public ASN, not the [Seattle Community Network](https://seattlecommunitynetwork.org) itself. If you would like to join the network visit our [connect](https://seattlecommunitynetwork.org/ourSites.html) page.
-Seattle Community Network (SCN) is a community network dedicated to providing fair access to underserved communities all across the Puget Sound. [Learn more on our FAQ]({{ "faq/about.html" | absolute_url }}).
+Seattle Community Network (SCN) is a community network dedicated to providing fair access to underserved communities all across the Puget Sound. [Learn more on our FAQ](../faq/about.md).
### Peering Policy
diff --git a/infrastructure/proxmox-vaultwarden-deployment.md b/docs/infrastructure/proxmox-vaultwarden-deployment.md
similarity index 98%
rename from infrastructure/proxmox-vaultwarden-deployment.md
rename to docs/infrastructure/proxmox-vaultwarden-deployment.md
index afe4da0..f9e19fc 100644
--- a/infrastructure/proxmox-vaultwarden-deployment.md
+++ b/docs/infrastructure/proxmox-vaultwarden-deployment.md
@@ -1,4 +1,6 @@
-# Proxmox Deployment Guide: Vaultwarden
+---
+title: Proxmox Deployment Guide - Vaultwarden
+---
### Deployed by: Esther Jang, Paul Phillion, Rudra Singh
@@ -58,12 +60,12 @@ services:
- To start and run your container application in detached mode, use:
- ```bash
- docker-compose up -d
- docker-compose start
- docker-compose stop
- docker-compose restart
- ```
+```bash
+docker-compose up -d
+docker-compose start
+docker-compose stop
+docker-compose restart
+```
## Section 7: Azure DNS
@@ -160,8 +162,8 @@ server {
#proxy_set_header Host $host;
#proxy_set_header X-Real-IP $remote_addr;
#proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- #proxy_set_header X-Forwarded-Proto $scheme;
+ #proxy_set_header X-Forwarded-Proto $scheme;
#proxy_pass http://vaultwarden-default;
}
}
diff --git a/infrastructure/sas-setup.md b/docs/infrastructure/sas-setup.md
similarity index 99%
rename from infrastructure/sas-setup.md
rename to docs/infrastructure/sas-setup.md
index b0e01cb..305e8b2 100644
--- a/infrastructure/sas-setup.md
+++ b/docs/infrastructure/sas-setup.md
@@ -1,6 +1,5 @@
---
title: Step 2. eNodeB and SAS Setup
-parent: Infrastructure
---
# Step 2: eNodeB and SAS Setup
@@ -54,6 +53,7 @@ The Google SAS portal can be found at: https://wirelessconnectivity.google.com/s
### B. Our Setup
Our test setup in the lab includes:
+
- 1W Baicells Nova 233 base station in the CBRS band mounted on the 6th floor balcony of our UW computer science building.
- Alpha Wireless 18 dBi-gain panel antenna with a beamwidth of 65 degrees (model AW3014-T4), mounted straight ahead and not tilted down.
@@ -66,6 +66,7 @@ An example configuration for this setup is shown below.
*The configuration screen is a right-hand sidebar next to the map view, hence the unwieldy aspect ratio.*
Explanation of parameters:
+
1. CBSD Category (A or B):
* Defined by rules in Section I.C above
2. User ID
diff --git a/infrastructure/software.md b/docs/infrastructure/software.md
similarity index 89%
rename from infrastructure/software.md
rename to docs/infrastructure/software.md
index 6776fb3..efbc19a 100644
--- a/infrastructure/software.md
+++ b/docs/infrastructure/software.md
@@ -1,7 +1,5 @@
---
title: Software Overview
-parent: Infrastructure
-nav_order: 2
---
# Our Software
@@ -20,10 +18,10 @@ Our EPC is powered by [Open5GS](https://github.com/open5gs/open5gs), an open-sou
### Spectrum Access System (SAS)
We have a partnership with [Google SAS](https://www.google.com/get/spectrumdatabase/sas/) to gain access to CBRS spectrum.
-Learn more about our SAS setup [here]({{ "infrastructure/sas-setup.html" | absolute_url }}).
+Learn more about our SAS setup [here](sas-setup.md).
### Network Monitoring and Alerting
-We use [LibreNMS](https://www.librenms.org) and SNMPd to monitor our nodes and provide alerting. Our Baicells-specific Network Manager setup is documented [here]({{ "infrastructure/librenms-manager-setup.html" | absolute_url }}), and our instructions for configuring a new node can be found [here]({{"infrastructure/librenms-setup.html" | absolute_url }}).
+We use [LibreNMS](https://www.librenms.org) and SNMPd to monitor our nodes and provide alerting. Our Baicells-specific Network Manager setup is documented [here](librenms-manager-setup.md), and our instructions for configuring a new node can be found [here](librenms-setup.md).
## Field Measurement
diff --git a/docs/learn/.pages b/docs/learn/.pages
new file mode 100644
index 0000000..23e333f
--- /dev/null
+++ b/docs/learn/.pages
@@ -0,0 +1,5 @@
+nav:
+ - wireless-communication.md
+ - cable-crimping.md
+ - lte-networks.md
+ - networking.md
\ No newline at end of file
diff --git a/learn/cable-crimping.md b/docs/learn/cable-crimping.md
similarity index 72%
rename from learn/cable-crimping.md
rename to docs/learn/cable-crimping.md
index 18ccb94..69ee336 100644
--- a/learn/cable-crimping.md
+++ b/docs/learn/cable-crimping.md
@@ -1,7 +1,5 @@
---
title: Crimping Ethernet Cables
-nav_order: 2
-parent: Learn
---
# Crimping Ethernet Cables
@@ -21,7 +19,7 @@ Here are some tools you should have in your crimping kit!
### RJ45 Crimping Tool
-![RJ45 Crimping Tool]({{site.url}}/assets/cable-crimping/kit-crimping-tool.jpg)
+![RJ45 Crimping Tool](../assets/cable-crimping/kit-crimping-tool.jpg)
An RJ45 crimping tool is the most essential tool. Although it's technically possible to crimp ethernet cables without this specialized tool, it's [not very practical](https://youtu.be/ysYLdFxNVuc) for crimping lots of cables.
@@ -29,25 +27,25 @@ Its primary utility is to do the actual 'crimping' part of compressing/crimping
### Cable Stripper
-![Cable Stripper]({{site.url}}/assets/cable-crimping/kit-cable-stripper.jpg)
+![Cable Stripper](../assets/cable-crimping/kit-cable-stripper.jpg)
Cable strippers are used to take off the protecting shielding around cables and expose the inner wires. You can also do the same thing with a simple blade or pair of scissors. The trickiest part about stripping cables is trying to avoid cutting the inner wires!
### RJ45 Connectors
-![RJ45 Connector]({{site.url}}/assets/cable-crimping/kit-rj45-connector.jpg)
+![RJ45 Connector](../assets/cable-crimping/kit-rj45-connector.jpg)
RJ45 connectors are required for crimping because they feature the 8 golden pins that get crimped onto the 8 wires of the ethernet cable. They are what get plugged into ethernet ports! They also feature a latch/clip that locks the ethernet cable into the port once it is plugged in.
### RJ45 Boots
-![RJ45 Boot]({{site.url}}/assets/cable-crimping/kit-rj45-boot.jpg)
+![RJ45 Boot](../assets/cable-crimping/kit-rj45-boot.jpg)
RJ45 boots can be optionally used to protect the RJ45 connector. It provides insulation and prevents the cable from being breaking easily. They have to put slipped onto the cable before you put on the RJ45 connectors though!
### RJ45 Cable Tester
-![RJ45 Cable Tester]({{site.url}}/assets/cable-crimping/kit-cable-tester.jpg)
+![RJ45 Cable Tester](../assets/cable-crimping/kit-cable-tester.jpg)
RJ45 cable testers allow you to guarantee that you did the job correctly!
@@ -59,11 +57,11 @@ Assuming you have a crimping kit and an ethernet cable that needs to be crimped,
### Step 0) Slip on the RJ45 boot (optional)
-![2 boots on a cable]({{site.url}}/assets/cable-crimping/0-boots.jpg)
+![2 boots on a cable](../assets/cable-crimping/0-boots.jpg)
### Step 1) Strip the cable
-![cable being stripped by cable stripper]({{site.url}}/assets/cable-crimping/1-strip.png)
+![cable being stripped by cable stripper](../assets/cable-crimping/1-strip.png)
- Push the cable into the razor slot of the strip tool and turn it around the cable to make an even cut around the sheath. Careful not to nick the wires inside!
- Unwrap the blue foil shielding and plastic to uncover the twisted wire pairs.
@@ -73,11 +71,11 @@ Assuming you have a crimping kit and an ethernet cable that needs to be crimped,
In this step, you'll be taking the 8 colored wires inside the ethernet cable and putting them into the correct ordering of colors.
-**NOTE**{: .label .label-red }This is the hardest part of crimping! The wires are small and are hard to control. Take your time and make sure you do this step correctly! Otherwise you might have to go back and restart.
+**NOTE**This is the hardest part of crimping! The wires are small and are hard to control. Take your time and make sure you do this step correctly! Otherwise you might have to go back and restart.
### Step 2.1) Untwist the wires
-![4 twisted pairs becoming 8 individual wires]({{site.url}}/assets/cable-crimping/2.1-untwist.png)
+![4 twisted pairs becoming 8 individual wires](../assets/cable-crimping/2.1-untwist.png)
There should be 4 pairs of wires: green, brown, orange, and blue. Each pair has a solid-colored wire and a striped-colored wire. Untwist these pairs and separate them into the 8 wires.
@@ -85,12 +83,12 @@ There should be 4 pairs of wires: green, brown, orange, and blue. Each pair has
After untwisting the wires, they are probably still kinked and look like they want to be twisted. In this step, you should carefully grab all the wires and try to straighten them out by pulling on them. This will prevent the wires from moving around later on.
-**WARNING**{: .label .label-red } Don't break off the wires!
+**WARNING** Don't break off the wires!
### Step 2.3) Lay out wires in order
-![Diagram showcasing ordering of RJ45 wires]({{site.url}}/assets/cable-crimping/2.3-color-diagram.png)
-![8 wires in RJ45 color order]({{site.url}}/assets/cable-crimping/2.3-ordered.png)
+![Diagram showcasing ordering of RJ45 wires](../assets/cable-crimping/2.3-color-diagram.png)
+![8 wires in RJ45 color order](../assets/cable-crimping/2.3-ordered.png)
With your straightened out wires, put them into the correct order! Make sure that the wires are all flat and in line with each other.
@@ -104,41 +102,41 @@ The ordering for these wires is:
7. Striped brown
8. Solid brown
-**TIP**{: .label .label-green} After laying them out in order, straighten them out again as a group! This will help keep the wires together.
+**TIP** After laying them out in order, straighten them out again as a group! This will help keep the wires together.
### Step 2.4) Trim the wires
-![trimmed wires]({{site.url}}/assets/cable-crimping/2.4-trim.png)
+![trimmed wires](../assets/cable-crimping/2.4-trim.png)
Trim the wires evenly to about 1/2 inch in length using scissors or the blade of your crimping tool. You want to make sure you have enough room for the wires to reach the end of the RJ45 connector. But also try to have room for the shielding of the cable to be inserted into the connector too.
-**TIP**{: .label .label-green} You can put the wires side-by-side to the RJ45 connector to see how long you should cut it. Look at the next step to see what the final product looks like.
+**TIP** You can put the wires side-by-side to the RJ45 connector to see how long you should cut it. Look at the next step to see what the final product looks like.
-**TIP**{: .label .label-green} If you don't have the shielding inside of the connector, it makes it easier for the wires to snap off later, which is bad.
+**TIP** If you don't have the shielding inside of the connector, it makes it easier for the wires to snap off later, which is bad.
-**TIP**{: .label .label-green} Make sure that you cut the wires evenly!
+**TIP** Make sure that you cut the wires evenly!
### Step 3) Slide wires into RJ45 connector
-![Wires inserted into RJ45 connector with clip-side down]({{site.url}}/assets/cable-crimping/3-diagram.png)
+![Wires inserted into RJ45 connector with clip-side down](../assets/cable-crimping/3-diagram.png)
Carefully slide your 8 wires into the connector. Make sure that the clip is facing away from you! If it is really hard to slide it into the connector, you probably didn't straighten out the wires enough in step 2.2 or 2.3.
-**MORE INFO**{: .label .label-yellow} Inserting the wires with the clip facing away from you is the standard. However, you could technically do it in 'reverse' and insert the wires with the clip facing you, as long as you do it on both ends of the cable. You shouldn't do this in practice though because others would get confused when looking at your cable.
+**MORE INFO** Inserting the wires with the clip facing away from you is the standard. However, you could technically do it in 'reverse' and insert the wires with the clip facing you, as long as you do it on both ends of the cable. You shouldn't do this in practice though because others would get confused when looking at your cable.
### Step 4) Crimp it
-![Inserting into crimping tool and crimping]({{site.url}}/assets/cable-crimping/4-crimp.png)
+![Inserting into crimping tool and crimping](../assets/cable-crimping/4-crimp.png)
Push the RJ45 connector into the slot of your crimping tool for RJ45 connectors. The slot should be labeled something like "8P" for the 8-pin RJ45 connector that you're using.
In this step, you're doing the actual 'crimping' part and crimping/compressing/stabbing the 8 golden pins on the RJ45 connector into the 8 colored wires.
-**TIP**{: .label .label-green} Squeeze as hard as you can! You need to make sure that all 8 pins are crimped.
+**TIP** Squeeze as hard as you can! You need to make sure that all 8 pins are crimped.
### Step 5) Test it
-![Testing with cable tester, green light showing]({{site.url}}/assets/cable-crimping/5-test.png)
+![Testing with cable tester, green light showing](../assets/cable-crimping/5-test.png)
Slide the two pieces of the tester apart and plug each of the cable ends into either piece. Turn the switch to “On” or “Slow.” If it's working, all 8 numbers should be flashing green.
diff --git a/learn/lte-networks.md b/docs/learn/lte-networks.md
similarity index 99%
rename from learn/lte-networks.md
rename to docs/learn/lte-networks.md
index c119532..453b2e6 100644
--- a/learn/lte-networks.md
+++ b/docs/learn/lte-networks.md
@@ -1,6 +1,5 @@
---
title: LTE Networks
-parent: Learn
---
# LTE Networks
diff --git a/learn/networking.md b/docs/learn/networking.md
similarity index 86%
rename from learn/networking.md
rename to docs/learn/networking.md
index 37f00d8..5bdcd4e 100644
--- a/learn/networking.md
+++ b/docs/learn/networking.md
@@ -1,6 +1,5 @@
---
title: Networking
-parent: Learn
---
# Learn about Computer Networks
@@ -8,4 +7,4 @@ parent: Learn
This page is currently in development. For now, please view our lesson on computer networks
from our Digital Stewards curriculum [here](https://docs.google.com/presentation/d/1efYpUrzymaL9CYRJ06KmrtZnZGhfYdAUahpo6TpdTNc/edit?usp=sharing).
-**TODO**{: .label .label-yellow}
+**TODO**
diff --git a/learn/wireless-communication.md b/docs/learn/wireless-communication.md
similarity index 99%
rename from learn/wireless-communication.md
rename to docs/learn/wireless-communication.md
index ad8ccbb..92644b5 100644
--- a/learn/wireless-communication.md
+++ b/docs/learn/wireless-communication.md
@@ -1,7 +1,5 @@
---
title: Wireless Communication
-parent: Learn
-nav_order: 1
---
# Crash Course in Wireless Communication
@@ -10,6 +8,7 @@ Authored by: Dominick Ta
Last updated: June 18th, 2021
TODO:
+
- [ ] Expand on transmit/receiving in antennas section
- [ ] Finish communication section
- [ ] Finish protocols section
@@ -42,6 +41,7 @@ To understand why radio waves are considered a type of electromagnetic radiation
We create radio waves by **moving electrons back and forth** within an electrically conductive object (an object made of material that allows electrons to move freely, such as metals).
This works because electrons have special properties:
+
- All electrons have '[electric fields](https://en.wikipedia.org/wiki/Electric_field)' surrounding them that attracts and repels other charged particles.
- All moving electrons produce '[magnetic fields](https://en.wikipedia.org/wiki/Magnetic_field)' that are the basis for how magnets work.
- Therefore, when electrons move there are two fields (electric & magnetic) present that combine to create creates an '[electromagnetic field](https://en.wikipedia.org/wiki/Electromagnetic_field)'.
diff --git a/faq/index.md b/faq/index.md
deleted file mode 100644
index e82da0d..0000000
--- a/faq/index.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: FAQ
-nav_order: 3
-has_children: true
----
-
-# FAQ - Frequently Asked Questions
-Answers to frequently asked questions can be found here.
diff --git a/index.md b/index.md
deleted file mode 100644
index f229c4c..0000000
--- a/index.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-title: Home
-nav_order: 1
----
-
-# Seattle Community Network Docs
-Welcome to the documentation website for the [Seattle Community Network](https://seattlecommunitynetwork.org/)! If you're looking for our main website, it is located at [https://www.seattlecommunitynetwork.org](https://seattlecommunitynetwork.org/).
-
-## You're in the Right Place
-
-Seattle Community Network has a place for **everyone**. Whether you'd like to join
-to [get free Internet]({{site.url}}/faq/connection.html), get involved to help out your community, learn some skills
-so that you can get a job, or all of the above!
-
-**PRO TIP**{: .label .label-green} We are a **community**. It's in our name! So, why not start by [joining our community]({{site.url}}/community/join.html)? It's easy.
-
-## What's here?
-Some topics you can find on this website include:
-- [FAQ]({{ "faq/" | absolute_url}}) - get the answers to some common questions.
-- [Community]({{ "community/" | absolute_url }}) - get involved and learn more about our community, our rules, and what we're up to.
-- [Learn]({{ "learn/" | absolute_url }}) - gain some new skills that you can use to help out with our networks.
-- [Infrastructure]({{ "infrastructure/" | absolute_url }}) - get the details on how our networks work behind the scenes.
\ No newline at end of file
diff --git a/infrastructure/index.md b/infrastructure/index.md
deleted file mode 100644
index 3353e31..0000000
--- a/infrastructure/index.md
+++ /dev/null
@@ -1,19 +0,0 @@
----
-title: Infrastructure
-has_children: true
-nav_order: 6
----
-
-# Our Infrastructure
-
-We'll explain everything about our infrastructure here.
-
-Why?
-- Help others set-up their own community networks
-- Help our volunteers understand how our stuff works
-- Help our users understand how they're receiving Internet access
-- Help our funders and partners learn more about our setup
-
-## Diagrams
-
-**TODO**{: .label .label-yellow}
diff --git a/learn/index.md b/learn/index.md
deleted file mode 100644
index e3f37a8..0000000
--- a/learn/index.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Learn
-nav_order: 5
-has_children: true
----
-
-# Learn
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..9f425e8
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,6 @@
+site_name: My Docs
+theme: readthedocs
+
+plugins:
+ - search
+ - awesome-pages
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..fddea51
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+mkdocs
+mkdocs-awesome-pages-plugin
\ No newline at end of file