search

loklak / dev.loklak.org

Loklak Documentation Repository http://dev.loklak.org
1.06k stars 8 forks source link

Add start page content and subprojects #2

Open mariobehling opened 7 years ago

mariobehling commented 7 years ago

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

yukiisbored commented 7 years ago

Adding sub-projects is described here: https://github.com/loklak/dev.loklak.org/wiki/How-to-add-documentations-to-dev.loklak.org

yukiisbored commented 7 years ago

I'm not a good web developer, we can create a javascript site as the start page which parses a JSON file that contains the projects and the meta-data so it'll dynamic.

mariobehling commented 7 years ago

Actually, could we make this part of the build process and simply have a static front page in the same design of the rest of the page?

yukiisbored commented 7 years ago

Yes, we can.

mariobehling commented 7 years ago

Should we keep the script in this repository therefore and trigger new builds regularly instead of keeping scripts in the different repositories?

yukiisbored commented 7 years ago

@mariobehling We can't do that, there's no free services for this.

mariobehling commented 7 years ago

What can we do? Would it work if we trigger new builds manually?

There are several issues with collecting documentation from different repositories in this way, e.g. no common search and need to ensure design is aligned with all of them.

Shouldn't we move a script that collects info from different repos to one repository?

imujjwal96 commented 7 years ago

Shall I create the start page using sphinx itself?

imujjwal96 commented 7 years ago

@mariobehling @yukiisbored What if we store the reStructuredText Markup file for the start page in the https://github.com/loklak/loklak repository and use CI to build it in the dev.loklak.org repository? Will that do the job?

mariobehling commented 7 years ago

@imujjwal96 This repo will be deleted. We need simple solutions. Surely, I can also come up with lots of other ideas, but how can we kee it simple? Let's not add additional repos, that don't actually hold info.

The start page of a project with several subprojects should be in the actual repo, that renders the website.