Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freifunk/projects.freifunk.net-contents
contents to be displayed at our projects-page
https://github.com/freifunk/projects.freifunk.net-contents
Last synced: 3 months ago
JSON representation
contents to be displayed at our projects-page
- Host: GitHub
- URL: https://github.com/freifunk/projects.freifunk.net-contents
- Owner: freifunk
- License: gpl-3.0
- Archived: true
- Created: 2017-11-21T08:55:21.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T19:29:01.000Z (11 months ago)
- Last Synced: 2024-06-21T13:35:19.306Z (5 months ago)
- Language: HTML
- Homepage: https://projects.freifunk.net
- Size: 2.62 MB
- Stars: 17
- Watchers: 18
- Forks: 30
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - freifunk/projects.freifunk.net-contents - contents to be displayed at our projects-page (others)
README
> [!IMPORTANT]
> We merged projects with the website repository. Please visit the repository of [projects.freifunk.net](https://github.com/freifunk/projects/tree/main/_projects) to add or edit your project.
# 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:
```
---
name: "Write Project Name Here"
desc: "Write a one line Description of Project here."
requirements:
- "The applicant has to fulfill this to get started."
difficulty: "low|medium|high"
size: "175 hours|350 hours"
issues:
- "https://github.com/coala/coala/issues/####"
mentors:
- sils
- sims1253
initiatives:
- GSoC
tags:
- Plugins
- CI
collaborating_projects:
- "Add umbrella and sub-orgs here"
---
This space is for the main description. Use it wisely.
#### Milestones
##### GSOC COMMUNITY BONDING
* Conceptual work should be finished.
* The contributor have a repository, know how to work with the community.
* The applicant should know the community.
##### GSOC MIDTERM
* Everything listed here has to be reviewed and merged by midterm.
* No exceptions to that. Changing the goals is possible together with mentors.
* Yes, that includes tests and documentation.
##### GSOC FINAL
* Everything has to be reviewed and merged.
* Including 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:
```
---
Question:
---
Answer
```
## 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 prerequisites
* install jekyll: ```sudo gem install jekyll bundler```
* checkout projects software ```git checkout https://github.com/freifunk/projects```
* delete contents of the original software
* ```rm projects/_projects```
* ```rm projects/_faq```
* copy our own contents
* ```cp collections/_projects projects/_projects```
* ```cp collections/_faq projects/_faq```
* run jekyll and bundler
* ```cd projects```
* ```bundle install```
* ```bundle exec jekyll serve```
## 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"```