Page MenuHomePhabricator

SecurePoll: Document extension changes [Timebox: 16 hours]
Closed, ResolvedPublic

Description

Motivation

The documentation for SecurePoll extension lives on Extension:SecurePoll page on MediaWiki. This page is primarily intended for third-party MediaWiki developers who might want to setup the extension on their wiki to serve their needs.

We should update this to reflect the recent changes we have made to the extension. This would include things like - new cli scripts added, new/modified configs etc.

Spec

Event Timeline

Niharika triaged this task as Medium priority.Aug 4 2021, 3:48 PM
Niharika created this task.
Niharika renamed this task from SecurePoll: Document extension changes to SecurePoll: Document extension changes [Timebox: 16 hours].Aug 4 2021, 4:27 PM

Two things that will probably have to be added:

  • We're going to remove the flag at some point but maybe not before this documentation ticket is done

Whomever code reviews the documentation - please begin at the (STV) Tallying part, that is where my changes start.

Also I added information about importing a poll using docker. "To import a poll using docker, run the following from the cli folder:"

Looks good! Just a few small things:

*caveat that it was meant to generate test elections. It hard codes a bunch of stuff in the election and is mostly meant to provide a scaffold election to tally on. This is different than the import script, which if I recall, does provide better parity from dumps.

Excellent thanks for the feedback @Tran

Great job Essex!

A few suggestions are below. These are nitpicking and not anything you did wrong. I still follow the military's view that documents should be understandable for someone with a 3rd-grade reading level and the thoughts below are to try and make things more explicit to avoid confusion for someone with no knowledge of this area.

I would change "Repeat 3–4" to "Repeat steps 3 and 4" to avoid any confusion. I see what you mean but my mind took a moment to catch what you meant.

A similar idea here "Repeat 3–7", especially since none of the steps are labeled 6 or 7.

"To execute a tally, run the following from the cli folder" can you mention where this is located, like "from 'extensions/SecurePoll/cli'"? The person doing this may have no idea there is a cli folder or try to execute this from the wrong cli folder while in their terminal. "To execute a tally using docker, run the following from the cli folder:" : same here.

Very good @Trent makes perfect sense.

@Niharika I have updated the documentation per Tran's and Trent's comments. Please do have a look and let me know your thoughts.

Looks good to me, @eigyan! Thank you for working on this.