freifunk/projects.freifunk.net-contents

Name: projects.freifunk.net-contents

Owner: Freifunk

Description: contents to be displayed at our projects-page

Created: 2017-11-21 08:55:21.0

Updated: 2018-04-30 18:33:18.0

Pushed: 2018-04-30 18:33:16.0

Homepage: https://projects.freifunk.net

Size: 2481

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

projects.freifunk.net-contents

contents to be displayed at our projects-page

Defining Projects

Mentors and admins can define projects in markdown using the following structure and save it in the collections/_projects folder with a relevant filename:

: "Write Project Name Here"
: "Write a one line Description of Project here."
irements:
The applicant has to fulfill this to get started."
iculty: "low|medium|high"
es:
https://github.com/coala/coala/issues/####"
ors:
ils
ims1253
iatives:
SoC
:
lugins
I
aborating_projects:
Add umbrella and sub-orgs here"


 space is for the main description. Use it wisely.

 Milestones

# GSOC 2017 COMMUNITY BONDING

nceptual work should be finished.
e student have a repository, know how to work with the community.
e applicant should know the community.

# GSOC 2017 MIDTERM

erything listed here has to be reviewed and merged by midterm.
 exceptions to that. Changing the goals is possible together with mentors.
s, that includes tests and documentation.

# GSOC 2017 FINAL

erything has to be reviewed and merged.
cluding tests and docs, again.

Defining FAQs

Users can also add FAQs by simply creating a markdown file in collections/_faq folder.

Format for faq markdown file is as follows:

tion: <Write the question here>


er

Local testing

Simple way

• push your file to github and look it up there. github renders your markdown file and should display a table above the main text. If that's the case it is valid, most probably :)

Advanced way

• install ruby and gem as prerequsites
• install jekyll: `sudo gem install jekyll bundler`
• checkout projects software `git checkout https://github.com/freifunk/projects`
• delete contents of the original software
• copy our own contents  * `cp collections/_projects projects/_projects`
• run jekyll and bundler

Deployment in Production

• install ansible
• run `ansible-playbook deploy_coala-projects.yml -i path-to-your-inventory --limit "the server to deploy to" --extra-vars "install_user=your-install-user install_path=/path/to/install"`