init - add planning files
This commit is contained in:
Jakub
commit
0844f1585c
71
contributing.md
Normal file
71
contributing.md
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
# Contributing Info
|
||||||
|
Info for those who want to help out with the website.
|
||||||
|
|
||||||
|
Universally you will need to knowhow to interact with a git repo. Contact Jakub and I will provide you with an account for accessing [the repos](https://git.jakubb.xyz/34mdh).
|
||||||
|
|
||||||
|
If we have enough interest in helping but a significant lack of needed knowledge I'd be down to host a crash course on some of this.
|
||||||
|
|
||||||
|
## Writing
|
||||||
|
If you want to write stuff, as in content, that will go on the webpage, you will need to know markdown. Either search up a crash course on youtube or visit [here](https://www.markdownguide.org/basic-syntax/).
|
||||||
|
|
||||||
|
We need 2 versions of each page, one in english and one in polish.
|
||||||
|
|
||||||
|
Pages to do:
|
||||||
|
- [ ] home page
|
||||||
|
- [ ] contact
|
||||||
|
- include when and where zbiorki are
|
||||||
|
- we launch after zimo so put Jakub's contact info
|
||||||
|
- make sure anyone who's contact info is on the site is ok with their contact being published
|
||||||
|
- [ ] about us
|
||||||
|
- [ ] what we do
|
||||||
|
- [ ] history
|
||||||
|
|
||||||
|
## Art
|
||||||
|
Logo design claimed by ______________________
|
||||||
|
|
||||||
|
### Task 1 logo
|
||||||
|
We need a logo to use.
|
||||||
|
Remember our druzyna's patron is gerneral pulaski (if im not mistaken).
|
||||||
|
It should be somewhat adaptable for use for use with social media, as a favicon and being featured on the site.
|
||||||
|
|
||||||
|
### task 2 - colors
|
||||||
|
We need a good color scheme.
|
||||||
|
See [here](./todo.md#design-details) for details
|
||||||
|
|
||||||
|
## Web Designing
|
||||||
|
If you want to help program the site there are some technical details you'll need to know about:
|
||||||
|
- We will be making a static html website using [hugo](https://gohugo.io), a static website generator.
|
||||||
|
- So we'll be making content in markdown files and hugo will take that and a few other resources, most importantly, our theme, which will be a fork of [this theme](https://git.jakubb.xyz/jakub/jakubb-hugo) hosted [here](https://git.jakubb.xyz/34mdh/hugo-theme).
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
- [ ] clean up the stylesheet, its sloppy af. dont change any values for now. if we want to make any layout tweaks we'll make it later.
|
||||||
|
We'll need to work on / create a few template pages. mainly:
|
||||||
|
- [ ] gallery-all
|
||||||
|
- [ ] gallery-single
|
||||||
|
- [ ] calendar-month
|
||||||
|
- [ ] calendar-year
|
||||||
|
- [ ] calendar-single-event
|
||||||
|
|
||||||
|
and a few shortcodes that will help with sharing details:
|
||||||
|
- [ ] location on a map
|
||||||
|
|
||||||
|
## Managment toolbox
|
||||||
|
We'll also work on some tools to make running 34mdh easier into the future. Most of there are small and could be done by one person in a few hours. Big projects will be noted as such
|
||||||
|
|
||||||
|
- [ ] Markdown to PDF for komunikats.
|
||||||
|
if were gonna use markdown for the site and emails (and possibly more into the future) we might as well go all the way and draft out komunikaty in md. Best option for this is probably a wrapper script for pandoc with a latex template for our komunikats.
|
||||||
|
|
||||||
|
- [ ] Calendar to email
|
||||||
|
- reads the upcoming calendar entries (3 weeks + when june, all of summer) and compiles them into an email for sekretarz to approve for sending.
|
||||||
|
- use html formating in them to make em nice and fancy
|
||||||
|
|
||||||
|
- [ ] Email list management,
|
||||||
|
will need a web component but this is lower on the priority list than the rest of them
|
||||||
|
- [ ] will need keep track of who gets emails in what langauges
|
||||||
|
|
||||||
|
- [ ] Deployment Script **BIG**
|
||||||
|
Incase we need to move or reinstall the vps or another druzyna would like to make use of out setup, it would be good to backup and automate the setup process of the webpage and its components as best as possible.
|
||||||
|
- [ ] nginx
|
||||||
|
- [ ] our **public** ssh keys
|
||||||
|
- [ ] main site
|
||||||
|
- [ ] any future additions
|
||||||
195
todo.md
Normal file
195
todo.md
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
# 34 MDH Webpage To Do
|
||||||
|
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
### Before work starts
|
||||||
|
- [ ] decide on sub pages
|
||||||
|
- [ ] home/landing page
|
||||||
|
- [ ] contact
|
||||||
|
- [ ] calendar
|
||||||
|
- [ ] news
|
||||||
|
- [ ] pictures
|
||||||
|
- [ ] about us
|
||||||
|
- [ ] documents
|
||||||
|
- mostly a copy of docs from [ZHP Harcerze](https://zhpharcerze.org)
|
||||||
|
- re-used forms
|
||||||
|
- roczna rejstracja
|
||||||
|
- permmision form
|
||||||
|
- etc.
|
||||||
|
- storage for waivers needed for trips
|
||||||
|
- skirmish
|
||||||
|
- vital
|
||||||
|
- etc.
|
||||||
|
- [ ] have [design](#design-details) planned out
|
||||||
|
- [ ] decide on design a logo for 34mdh
|
||||||
|
|
||||||
|
### Before Launch
|
||||||
|
- [ ] hugo theme basics
|
||||||
|
[git repo](https://git.jakubb.xyz/jakub/jakubb-hugo)
|
||||||
|
- [ ] write html skeletons for
|
||||||
|
- [ ] header
|
||||||
|
- [ ] navbar
|
||||||
|
- [ ] body-lists
|
||||||
|
- [ ] body-articles
|
||||||
|
- [ ] body-calendar-year
|
||||||
|
- [ ] body-calendar-month
|
||||||
|
- [ ] body-calendar-event
|
||||||
|
may be just as well served by body-article. **TBD**
|
||||||
|
- [ ] body-home
|
||||||
|
- [ ] footer
|
||||||
|
- [ ] write stylesheet
|
||||||
|
make sure that:
|
||||||
|
- [ ] code is clean and consistant
|
||||||
|
- [ ] there are no glaring ui bugs
|
||||||
|
|
||||||
|
- [ ] make basic site content
|
||||||
|
- [ ] contact info
|
||||||
|
- [ ] importatnt docs
|
||||||
|
- [ ] upcoming event info
|
||||||
|
- [ ] donation info
|
||||||
|
- [ ] socials
|
||||||
|
- [ ] various related FB pages
|
||||||
|
- [ ] insagram
|
||||||
|
|
||||||
|
- [ ] Launch Day prep
|
||||||
|
- [ ] secure a domain
|
||||||
|
Best option 34mdh.org, but its taken. Check with old komenda if we can get
|
||||||
|
accsess to it. Runner ups are 34mdhzhp.org and zhp34mdh.org
|
||||||
|
- [ ] contact old komenda members regarding 34mdh.org
|
||||||
|
- [X] ~~Krużel Brothers~~ 1/29
|
||||||
|
Don't know
|
||||||
|
- [X] ~~Dominik Pulawski~~ 1/29
|
||||||
|
Doesn't know
|
||||||
|
- [ ] Robert Niespór
|
||||||
|
Jakub emailed 1/29
|
||||||
|
waiting for repsonse
|
||||||
|
- [ ] Patryk Gryczka
|
||||||
|
- [ ] secure hosting
|
||||||
|
we can use Jakub's vps for now. Eventually album size will outgrow that and
|
||||||
|
a dedicated 34mdh vps will be needed.
|
||||||
|
- [ ] upload site, inform other druzyny, parents, etc.
|
||||||
|
|
||||||
|
### Post Launch Upgrades and additions
|
||||||
|
- [ ] Add `beta` subdomain to DNS record
|
||||||
|
- [ ] Launch clone of site on said subdomain with updated site for testing
|
||||||
|
|
||||||
|
- Integrate Sekretarz duties automation
|
||||||
|
- [ ] host our own mail server
|
||||||
|
- requires atleast 1 month of history w/ vps provider (hetzner)
|
||||||
|
- then komenda members/positions can have dedicated emails just for harc
|
||||||
|
ex: druzynowy@34mdh.org or gabriel.gosk@34mdh.org
|
||||||
|
- [ ] auto gen emails based off calendar
|
||||||
|
- calendar entriea will be standardized markdown files used for the website.
|
||||||
|
- a script will scan the entries and use their contents to generate 99% of the email.
|
||||||
|
- this means that ..x.. **TBD** before any event, reminders will already be in the weekly email
|
||||||
|
- sekretarz's job will be easier cause they will just need to be the human that aproves and possibly correct the generated email
|
||||||
|
- [ ] start making html (fancy emails) to add some flair passed the basic text of past emails
|
||||||
|
- [ ] expand website, calendar, and emails to be in both english and polish
|
||||||
|
segregate email list based off of language prefrence
|
||||||
|
- [ ] 'automate' email list(s) management
|
||||||
|
- [ ] make a section on webpage where people can sign up for emails in
|
||||||
|
- english
|
||||||
|
- polish
|
||||||
|
- both languages
|
||||||
|
- [ ] include a small gray link in html emails with link to website to unsubscribe from the polish, english or both email lists
|
||||||
|
|
||||||
|
- photo albums
|
||||||
|
**Possible fundraising idea** have a dropshiping link to buy printed photo albums at the end of the year. Profit goes to druzyna.
|
||||||
|
- [ ] write a compression script that will
|
||||||
|
- [ ] compress images to a reasonable size
|
||||||
|
- [ ] create thumbnails of said images
|
||||||
|
- [ ] integrate well with / be part of the hugo theme
|
||||||
|
- [ ] greate zip files with full albums
|
||||||
|
- [ ] create a torrent with files
|
||||||
|
- [ ] make vps serve as tracker for said torrents
|
||||||
|
|
||||||
|
- after events w/ kronika
|
||||||
|
- (Jakub|Kronikaz druzyny) **TBD** to add all good pics to a directory
|
||||||
|
- run script to generate album
|
||||||
|
- upload album to website
|
||||||
|
- pick 2-4 good ones to put on ig/fb
|
||||||
|
advertise that full albums are on website
|
||||||
|
|
||||||
|
- [ ] disclosure of donation use, Donation portal, and tax write offs
|
||||||
|
- Usage disclosures
|
||||||
|
- Log of in person donations (see [here](#donations)) to be upkept by skarbnik
|
||||||
|
- To be released every ..**TBD**.. including
|
||||||
|
- donations from various sources
|
||||||
|
- what money was spent on
|
||||||
|
- Online Donation Portal
|
||||||
|
- [ ] requires 34mdh bank account setup
|
||||||
|
- [ ] setup stripe
|
||||||
|
- [ ] setup fosspay on vps
|
||||||
|
- [ ] see posible integrations of auto-gen tax write off recipts
|
||||||
|
- Tax write offs
|
||||||
|
- talk to skarbik hufca before anything
|
||||||
|
all i know is that we can
|
||||||
|
|
||||||
|
- general scouting komenda resource archive
|
||||||
|
Will make ours and other druz/programowy's job much easier for years to come.
|
||||||
|
Can also make participant's lives easier, especially ifwe start asking them to do "homework."
|
||||||
|
- [ ] copy a bunch of documents from [zhp harcerze](https://zhpharcerze.org) and host on our own site
|
||||||
|
- [ ] archive a bunch of rozgrywki / zajencia on the site
|
||||||
|
- [ ] have a collection of knot, polska/harcerska historia, and other scouting info
|
||||||
|
|
||||||
|
- make running 34mdh easier, especially in terms of komenda colabaration.
|
||||||
|
you can say that the photo email, photo album and archive stuff can be included in this section.
|
||||||
|
- [ ] find premade markdown file colabaration tools
|
||||||
|
- [ ] find an easy way to turn MD into pdf komunikats
|
||||||
|
best bet is to make a latex template and to use pandoc for conversions.
|
||||||
|
- [ ] make an easy way for anyone in komenda to upload a komunikat/plan for an event to have sek./druz. approve its publishing onto the site
|
||||||
|
- [ ] clean up the discord server a bit. self host matrix or some if we wanna be extra asf
|
||||||
|
- get mlodzi on it to be able to contact them / have them contact us
|
||||||
|
- works as a good colab tool
|
||||||
|
|
||||||
|
- out-of-zbiorka participant engagement
|
||||||
|
- publish punktacja and "homework" achivements on the site to inspire attendacne and competiton
|
||||||
|
|
||||||
|
- harc advertising
|
||||||
|
- [ ] add conent regarding history and current activity to draw in new members and possible donors
|
||||||
|
|
||||||
|
- [ ] continutance plans for server management
|
||||||
|
- [ ] move everything that may be linked to a personal account of jakub's to
|
||||||
|
a dedicated 34mdh account
|
||||||
|
- [ ] make sure someone in future komenda understands how to take care of the
|
||||||
|
vps and domain registration
|
||||||
|
|
||||||
|
## Design Details
|
||||||
|
- Logos:
|
||||||
|
- ![logo-favicon.png]()
|
||||||
|
- ![logo-navbar.png]()
|
||||||
|
- ![logo-social.png]()
|
||||||
|
- ![logo-mobile-nav.png]()
|
||||||
|
-
|
||||||
|
- Fonts:
|
||||||
|
| Title | Used for | Font Name |
|
||||||
|
| ----- | --------------- | --------- |
|
||||||
|
| | Headings/titles | |
|
||||||
|
| | Body Text | |
|
||||||
|
| | Photo Captions | |
|
||||||
|
|
||||||
|
- Color Scheme:
|
||||||
|
| Title | Used for | Light Mode # | Dark Mode # |
|
||||||
|
| -------------------- | -------------- | ------------ | ----------- |
|
||||||
|
| Main Background | | | |
|
||||||
|
| Main Text | | | |
|
||||||
|
| Alternate background | navbar, frames | | |
|
||||||
|
| Accent color 1 | links | | |
|
||||||
|
| Accent color 2 | navbar | | |
|
||||||
|
| Accent color 3 | headings | | |
|
||||||
|
|
||||||
|
- Layouts:
|
||||||
|
- Wide screen
|
||||||
|
- sidebar on the left with logo and navigation near top, ..TBD.. info near bottom
|
||||||
|
- mid width
|
||||||
|
- bar runing across top, logo in top left, navbar buttons on right
|
||||||
|
- mobile
|
||||||
|
- bar with logo running across top, tap for dropdown navigation
|
||||||
|
|
||||||
|
## Donations
|
||||||
|
Donations include but are not limited to:
|
||||||
|
- grants
|
||||||
|
- skladka
|
||||||
|
- online donations
|
||||||
|
|
||||||
|
I'm bringing up donations alot in this document because zbiroki feel cheap and that may be holding us back. We shouldn't be scared to ask for and use money to make zbiorki more fun for participants, aka happier participants aka more participatns aka better druzyna.
|
||||||
Loading…
Reference in New Issue
Block a user