loklak / dev.loklak.org

Loklak Documentation Repository http://dev.loklak.org

dev.loklak.org

This repository aggregates separated rendered HTML pages from various Loklak projects.

Please do not submit issues or pull requests to this repository. Due to the fact it's automated and only contains rendered HTML pages.

Aggregation is achieved with git subtree which is used over submodules for stability reasons.

dev.loklak.org's Issues

Clarifying build of dev.loklak.org site

I am unclear how this repository is supposed to work and except for "do not add issues" I do not find relevant info.

Right now the site only holds the server documentation. How can contributors add other relevant repositories and trigger the build?

I think the following would be expected:

• The script should probably stay in this repository, but the question is how can it be triggered?
• The Readme.md of this repository should be the start page of dev.loklak.org and it should list all repositories that are included in this repo
• There should be information "How to add other repositories to dev.loklak.org"

What are the steps to create a theme or change the existing theme?

The site has a basic style already. How can this style be changed now?

Add start page content and subprojects

Add the following content as the start page of the dev.loklak.org. Each subproject should get a page. How to add subprojects?

---

loklak

'Lok Lak' is a very tasty Cambodian stir-fry meat dish with a lot of fresh black pepper. I hope not to scare vegetarians with this name, currently I am one as well. And, loklak is also the name of this project that the goal of collecting and indexing social media message data in a peer to peer network to enable users to analyze big data.

loklak server

The loklak server is a server application which is able to collect messages from various sources, including twitter. The server contains a search index and a peer-to-peer index sharing interface. All messages are stored in an elasticsearch index. An automatic deployment from the development branch at GitHub is available for tests here https://loklak-server-dev.herokuapp.com

Code: github.com/loklak/loklak_server

Project Site: api.loklak.org

Documentation: dev.loklak.org/server

loklak search

loklak search is an Angular.js web application that provides a search interface for end users of loklak data and showcases some of the possibilities to use loklak data for analytics.

Code: github.com/fossasia/loklak_search

Project Site: loklak.net

Documentation: dev.loklak.org/search/

loklak apps

loklak apps is a collection of small web apps that make use, analyze and visualize of the data of the loklak server. loklak apps use the loklak api server.

Code: github.com/fossasia/apps.loklak.org

Project Site: apps.loklak.org

Documentation: dev.loklak.org/webapps/

loklak wok

The loklak wok is an Android application collecting data.

Code: github.com/fossasia/loklak_wok

Documentation: dev.loklak.org/androidwok/

loklak wok Desktop

The loklak wok is a Desktop application collecting data.

Code: github.com/loklak/loklak_wok_desktop

Documentation: dev.loklak.org/desktopwok/

loklak APIs

loklak_go_api

Go library client for using the Loklak API

loklak_dotnet_api

A C#.NET Wrapper for Loklak to be used with Windows applications

loklak_python_api

The loklak API for Python which makes it very easy to use and as a strict replacement to the twitter API

loklak_php_api

The PHP Library for accessing loklak.org

loklak_ruby_api

Ruby wrapper for loklak.org API - distributed tweet search server

loklak_nodejs_api

Node js wrapper for the loklak API.

loklak_jlib_api

One Library to find them, One Library to bring them all

loklak_IBM_Home_Automation

IOT update integration for Loklak to be able to receive GENERIC data from IBM Home Automation ibmiotf

Add social bar

Add the following content to social bottom bar.

loklak.github.io

##Loklak Resources

GitHub: https://github.com/loklak

Blog: https://blog.loklak.net

Web Server: https://loklak.org

Web Client Showcase: http://loklak.net

Gitter Channel: https://gitter.im/loklak

Mailing List: https://groups.google.com/forum/#!forum/loklak

Facebook: https://www.facebook.com/loklakmessages/

Twitter:

• https://twitter.com/loklak_app
• https://twitter.com/loklak_messages
• https://twitter.com/lklknt

YouTube: https://www.youtube.com/channel/UCXbDoitUSy8u_1pUO93kiCw

G+: https://plus.google.com/b/100484940238909889971/100484940238909889971

LinkedIn: https://www.linkedin.com/company/loklak

Unequal sizes of the deploy bar tabs

These tabs are unequally sized.It would be better if they were equally sized both in terms of height and width.

Optimize search bar

The Go button should be on the immediate right of the search bar rather than being on a new line

Integrate Yaydoc to generate documentation

Integrate Yaydoc to generate documentation.
add the yaydoc.yml and specify all the necessary sub projects.

Migrate documentations

Due to a couple of problems regarding aggregating documentations. I'm planning to build the docs in this repository via Travis instead of aggregating pre-compiled HTML pages. This will ensure that every documents are working correctly and are handled by a single instance of sphinx.

It'll be based of 3 components:

• A script that pushes the raw reStructuredText/Markdown files to the master branch of this repository.
• A script that combines index files into a single index.rst. Obviously this has to be written in rST.
• A CI setup in this repository that compiles the documents with Sphinx into a accessible website.

Decide where to leave this CoC

CoC as follows.

======================

Code of Conduct

A member of our community is:

Open

Members of the community are open to collaboration, whether it's on PEPs, patches, problems, or otherwise. We're receptive to constructive comment and criticism, as the experiences and skill sets of other members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate and everyone can make a difference.

Considerate

Members of the community are considerate of their peers -- other FOSSASIA users. We're thoughtful when addressing the efforts of others, keeping in mind that often times the labor was completed simply for the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.

Respectful

Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments, and their efforts. We're respectful of the volunteer efforts that permeate the FOSSASIA community. We're respectful of the processes set forth in the community, and we work within them. When we disagree, we are courteous in raising our issues.

Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.

Note
This document is based on Code of Conduct of the Python Software Foundation: https://www.python.org/psf/codeofconduct/

Anti-Harassment Policy

Simply having an anti-harassment policy can prevent harassment all by itself and encourages people to attend who have had bad experiences at other events. It also gives event staff instructions on how to handle harassment quickly, with the minimum amount of disruption or bad press for the event.

FOSSASIA is dedicated to providing harassment-free experience at our events for everyone, regardless of gender, sexual orientation, disability, gender identity, age, race, or religion. We do not tolerate harassment of event participants in any form. Participants asked to stop any harassing behavior are expected to comply immediately. Exhibiting partners at events are also subject to the anti-harassment policy. In particular, exhibitors should not use sexualized images, activities, or other material, or otherwise create a sexualized environment.

If a participant engages in harassing behavior, the event organizers may take any action they deem appropriate, including warning the offender or expulsion from the event. If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact a member of conference staff immediately. Our Event Staff can usually be identified by special badges/attire.

Please note, while we take all concerns raised seriously, we will use our discretion as to in determining when and how to follow up on reported incidents and may decline to take any further action and/or may direct the participant to other resources for resolution. Event staff will be happy to help participants contact venue/event security or local law enforcement, provide escorts, or otherwise assist those experiencing harassment to feel safe for the duration of the conference. We value your attendance.

We expect participants to follow these rules at all event venues and related social events.

License and attribution

This policy is licensed under the Creative Commons Zero license.

This policy is based on several other policies, including the Ohio LinuxFest anti-harassment policy, written by Esther Filderman and Beth Lynn Eicher, and the Con Anti-Harassment Project. Mary Gardiner, Valerie Aurora, Sarah Smith, and Donna Benjamin generalized the policies and added supporting material. Many members of LinuxChix, Geek Feminism and other groups contributed to this work.