|
1 | 1 | --- |
2 | 2 | layout: page |
3 | | -title: Docsy Jekyll Theme |
| 3 | +title: Elekto Project Home |
4 | 4 | permalink: / |
5 | 5 | --- |
6 | 6 |
|
7 | | -# Welcome to Docsy Jekyll |
| 7 | + |
8 | 8 |
|
9 | | -This is a starter template for a docsy jekyll theme. |
| 9 | +# Welcome to The Elekto Project |
10 | 10 |
|
11 | | - |
| 11 | +The Elekto Project develops Elekto, simple software for secure online elections. |
12 | 12 |
|
13 | | -## Purpose |
| 13 | +Elekto was created as part of an [LFX](https://lfx.linuxfoundation.org/) internship for the Kubernetes project |
| 14 | +by [Manish Sahani](https://github.com/kalkayan), and is now a [CNCF](https://www.cncf.io) infrastructure project. |
14 | 15 |
|
15 | | -GitHub pages uses Jekyll natively, so when I make documentation, I typically |
16 | | -look for Jekyll templates. Why? Using Jekyll means that I can use markdown, |
17 | | -and allow for users to easily contribute, and build automatically just by |
18 | | -way of pushing to a master branch (or general GitHub pages). |
19 | | -I found Docsy, a beautiful Hugo template, but it requires hugo with GoLang |
20 | | -which doesn't render natively on GitHub pages. For this reason, I've spent |
21 | | -some time creating a custom Jekyll template that is (almost) as beautiful, |
22 | | -and includes all the features that I might want. |
| 16 | +*If you have reached here trying to vote in an online election, you are in the wrong place.* |
23 | 17 |
|
24 | 18 | ## Features |
25 | 19 |
|
26 | | -What are these features? You should see the {% include doc.html name="Getting Started" path="getting-started" %} |
27 | | -guide for a complete summary. Briefly: |
| 20 | +Elekto was designed to support the following: |
28 | 21 |
|
29 | | - - *User interaction* including consistent permalinks, links to ask questions via GitHub issues, and edit the file on GitHub directly. |
30 | | - - *Search* across posts, documentation, and other site pages, with an ability to exclude from search. |
31 | | - - *External Search* meaning an ability to link any page tag to trigger an external search. |
32 | | - - *Documentation* A documentation collection that was easy to organize on the filesystem, render with nested headings for the user, and refer to in markdown. |
33 | | - - *Pages* A separate folder for more traditional pages (e.g, about). |
34 | | - - *Navigation*: Control over the main navigation on the left of the page, and automatic generation of table of contents for each page on the right. |
35 | | - - *News* A posts feed for news and updates, along with an archive (organized by year). |
36 | | - - *Templates* or specifically, "includes" that make it easy to create an alert, documentation link, or other content. |
37 | | - - *Continuous Integration* recipes to preview the site |
| 22 | +- 100% [GitOps](https://about.gitlab.com/topics/gitops/) workflow for configuration and election administration |
| 23 | +- 100% Oauth-driven workflow for voters (no emails) |
| 24 | +- Preference election voting (starting with Condorcet) |
| 25 | +- Multiple elections for the same organization |
| 26 | +- Responsive web design |
| 27 | +- Secret ballot voting |
38 | 28 |
|
39 | | - |
40 | | -For features, getting started with development, see the {% include doc.html name="Getting Started" path="getting-started" %} page. Would you like to request a feature or contribute? |
41 | | -[Open an issue]({{ site.repo }}/issues) |
| 29 | +The Elekto project was inspired by the long-running [CIVS project](https://github.com/andrewcmyers/civs). |
0 commit comments