Skip to content

Commit 9c0bc95

Browse files
committed
Customize docs/site for Elekto.
1 parent 7f4e403 commit 9c0bc95

5 files changed

Lines changed: 31 additions & 31 deletions

File tree

assets/img/banner.jpg

50.8 KB
Loading
-53.8 KB
Binary file not shown.

assets/img/docsy-jekyll.png

-232 KB
Binary file not shown.

pages/about.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,23 @@ permalink: /about/
55

66
# About
77

8-
This is a [starter template](https://vsoch.github.com/docsy-jekyll/) for a Docsy jekyll theme, based
9-
on the Beautiful [Docsy](https://github.com/google/docsy) that renders with Hugo. This version is intended for
10-
native deployment on GitHub pages. See the [respository]({{ site.repo }}) for more details.
8+
This is the homepage and documentation for the Elekto Project, simple online
9+
elections software.
10+
11+
## Copyright
12+
13+
This documentation and website are Copyright 2020-2021 The Cloud Native Computing
14+
Foundation and the collected contributors to The Elekto Project. They are made
15+
available to the public under [The Apache License 2.0](https://www.github.com/{{ site.github_user }}/{{ site.github_repo }}/LICENSE).
1116

1217
## Support
1318

14-
If you need help, please don't hesitate to [open an issue](https://www.github.com/{{ site.github_user }}/{{ site.github_repo }}).
19+
We cannot assist with any election in progress running on an instance of Elekto,
20+
nor do we host elections for organizations.
21+
22+
If you find other issues with the software itself, please don't hesitate
23+
to [open an issue](https://www.github.com/{{ site.github_user }}/{{ site.github_repo }}).
24+
25+
## Code Of Conduct
1526

27+
The Elekto Project supports and is subject to the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

pages/index.md

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,29 @@
11
---
22
layout: page
3-
title: Docsy Jekyll Theme
3+
title: Elekto Project Home
44
permalink: /
55
---
66

7-
# Welcome to Docsy Jekyll
7+
![assets/img/banner.jpg](assets/img/banner.jpg)
88

9-
This is a starter template for a docsy jekyll theme.
9+
# Welcome to The Elekto Project
1010

11-
![assets/img/docsy-jekyll.png](assets/img/docsy-jekyll.png)
11+
The Elekto Project develops Elekto, simple software for secure online elections.
1212

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.
1415

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.*
2317

2418
## Features
2519

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:
2821

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
3828

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

Comments
 (0)