Skip to content

Commit

Permalink
Initial gsm.emf.camp docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bonzi committed Apr 30, 2024
1 parent 5edbd7a commit 30674a1
Show file tree
Hide file tree
Showing 17 changed files with 2,789 additions and 43 deletions.
76 changes: 76 additions & 0 deletions .github/workflows/live-deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Deploy live site to GitHub Pages

on:
push:
branches:
- main

# This workflow can be run manually from the Actions tab
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

defaults:
run:
shell: bash

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0

- name: Setup Pages
id: pages
uses: actions/configure-pages@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: 1.22

- name: Install Hugo and other dependencies
run: npm ci

- name: Build the site
run: |
npm run build
env:
# For maximum backward compatibility with Hugo modules
HUGO_ENVIRONMENT: production
HUGO_ENV: production

- name: Bundle up built site as an artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./public

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
43 changes: 0 additions & 43 deletions .github/workflows/static.yml

This file was deleted.

9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
node_modules/

# Hugo-generated files
/public/
/resources/_gen/
/assets/jsconfig.json
hugo_stats.json
# Temporary lock file while building
/.hugo_build.lock
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
hugo extended_0.122.0
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# gsm.emfcamp.org

These are the source files for <https://gsm.emfcamp.org>.

The site is statically generated using [Hugo](https://gohugo.io) and the [Docsy theme](https://www.docsy.dev).

If you're just here to edit page content, what you need is in the [`content/` subdirectory](content/).
4 changes: 4 additions & 0 deletions assets/icons/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// lifted from emfcamp/Website:css/_variables.scss
$brand-2024-pale-green: #AFC944;
$brand-2024-mid-green: #528329;
$brand-2024-dark-green: #213018;
$brand-2024-yellow: #F9E200;
$brand-2024-orange: #F77F02;
$brand-2024-pink: #F55089;
$brand-2024-blue: #2EADD9;

$emf-colours: (
"emf-pale-green": $brand-2024-pale-green,
"emf-mid-green": $brand-2024-mid-green,
"emf-dark-green": $brand-2024-dark-green,
"emf-yellow": $brand-2024-yellow,
"emf-orange": $brand-2024-orange,
"emf-pink": $brand-2024-pink,
"emf-blue": $brand-2024-blue,
);

// EMF 2024 Dark Green
$primary: #213018;

// EMF 2024 Orange
$secondary: #f77f02;

$google_font_name: "Titillium Web";
$google_font_family: "Titillium+Web:300,300i,400,400i,700,700i";
2 changes: 2 additions & 0 deletions assets/scss/_variables_project_after_bs.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// American spelling, this is a Bootstrap variable we're overriding.
$theme-colors: map-merge($theme-colors, $emf-colours);
26 changes: 26 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
toc_root: true
cascade:
- type: docs
---

This is the documentation for the EMF GSM Network
{.h2}


<!--
{{% pageinfo color="danger" %}}
WARNING: THESE PAGES ARE FROM EMF 2022
{.h2 .text-center}
Some things may change or not be available at the 2024 event.
We are hoping to start updating the content on this site soon. (You can help out!)
{{% /pageinfo %}}
-->


To get support and or talk to us about these services, join us in the [#emfcamp-gsm IRC
channel](https://web.libera.chat/?channel=#emfcamp-gsm) on [Libera Chat](https://libera.chat/)
6 changes: 6 additions & 0 deletions content/_search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Search Results
layout: search
toc_hide: true
hide_summary: true
---
29 changes: 29 additions & 0 deletions content/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Getting Started
description: >
How to connect to, and use, the EMF GSM network
---

# Prereqs

1. Have a c3gsm (e)SIM
- These can be procured from the shop/emfgsm team
- (e)SIMs from previous c3 events should work
2. Have a phone compatable with GSM1800
3. Have a spare 5 minuites

# First Steps

1. Register an event telephony extension online
2. Insert SIM card into phone (not necessary if you deployed an eSIM profile)
3. Disable VoLTE for 4G on your phone
- VoLTE is known to cause issues
4. Set APN on your phone to `internet`
5. Call your chosen extentions registration number shown in \[REDACTED].
6. Enjoy

# Once connected

See our friends over at EMF POC for some example numbers to call [here]()

For services specific to the EMF GSM network, please see the [Services](/services/) page
9 changes: 9 additions & 0 deletions content/services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Services
description: >
Services dedicated to the EMF GSM network
---

# Codes
- `*#100#`: Retreives your assigned Extention
- `*#101#`: Retreives your IMSI
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/emfcamp/gsm.emfcamp.org

go 1.14

require github.com/google/docsy v0.9.1 // indirect
4 changes: 4 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
github.com/FortAwesome/Font-Awesome v0.0.0-20240108205627-a1232e345536/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/google/docsy v0.9.1 h1:+jqges1YCd+yHeuZ1BUvD8V8mEGVtPxULg5j/vaJ984=
github.com/google/docsy v0.9.1/go.mod h1:saOqKEUOn07Bc0orM/JdIF3VkOanHta9LU5Y53bwN2U=
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
130 changes: 130 additions & 0 deletions hugo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
baseURL = "https://gsm.emfcamp.org/"
title = "gsm.emfcamp.org"
description = "Documentation for the EMF GSM Network."

# Language settings
contentDir = "content"

enableRobotsTXT = true

# Will give values to .Lastmod etc.
enableGitInfo = true

# Comment out to enable taxonomies in Docsy
# disableKinds = ["taxonomy", "taxonomyTerm"]

# You can add your own taxonomies
[taxonomies]
tag = "tags"
category = "categories"

[params.taxonomy]
# set taxonomyCloud = [] to hide taxonomy clouds
taxonomyCloud = ["tags", "categories"]

# If used, must have same length as taxonomyCloud
taxonomyCloudTitle = ["Tag Cloud", "Categories"]

# set taxonomyPageHeader = [] to hide taxonomies on the page headers
taxonomyPageHeader = ["tags", "categories"]


# Highlighting config
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle = "tango"

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

# Language configuration

[languages]
[languages.en]
languageName ="English"
weight = 1

[markup]
[markup.goldmark]
[markup.goldmark.parser.attribute]
block = true
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"

# Everything below this are Site Params

[params]
# First one is picked as the Twitter card image if not set on page.
# images = ["images/project-illustration.png"]

github_repo = "https://github.com/emfcamp/gsm.emfcamp.org"
github_branch= "main"

offlineSearch = true
prism_syntax_highlighting = true

# User interface configuration
[params.ui]
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
navbar_logo = true
navbar_translucent_over_cover_disable = false
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = false
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = false

[params.ui.feedback]
enable = false

[params.ui.readingtime]
enable = false

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "www.emfcamp.org"
url = "https://emfcamp.org/"
icon = "fa fa-globe"
desc = "EMF main website"
[[params.links.user]]
name ="Fediverse"
url = "https://social.emfcamp.org/@gsm"
icon = "fab fa-mastodon"
desc = "Follow us on the Fediverse to get the latest news!"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub repo"
url = "https://github.com/emfcamp/gsmfcamp.org"
icon = "fab fa-github"
desc = "Source for this website!"
[[params.links.developer]]
name = "IRC web chat"
url = "https://web.libera.chat/?channel=#emfcamp-lte"
icon = "fa fa-comments"
desc = "Web (IRC) chat (ignore the LTE, maybe next time)"

# hugo module configuration

[module]
# Uncomment the next line to build and serve using local docsy clone declared in the named Hugo workspace:
# workspace = "docsy.work"
[module.hugoVersion]
extended = true
min = "0.110.0"
[[module.imports]]
path = "github.com/google/docsy"
disable = false
Loading

0 comments on commit 30674a1

Please sign in to comment.