Page MenuHomePhabricator

Update technical documentation for SecurePoll [8 hours]
Closed, ResolvedPublic

Description

Motivation

AHT has done a lot of work on SecurePoll. We should update the extension page to reflect the changes.

Acceptance criteria

Event Timeline

Niharika triaged this task as Medium priority.Mar 10 2021, 3:36 PM
Niharika created this task.
Niharika renamed this task from Update technical documentation for SecurePoll to Update technical documentation for SecurePoll [8 hours].Mar 24 2021, 4:24 PM

https://www.mediawiki.org/wiki/Extension:SecurePoll#Usage has been expanded to document more administrator actions.

In particular these new features have been documented:

  • Editing a poll after an election has begun
  • Logging when admins have been added to / removed from an election, and when they view private user data
  • Changes to the tallying workflow

The level of detail allows for minor changes to the code without the need to update this documentation.

Any AHT engineers reviewing this, feel free to ask questions or edit the page directly.

@Niharika How does this look?

We talked about adding a known bugs section, but I since remembered this issue tracker link at the top of the page, which will give a more comprehensive and up-to-date coverage of known bugs.

Moving to Done - @Niharika feel free to close this if it looks OK to you.

@Tchanders I added a couple screenshots of the new logs we added. Looks all good to me.
We need to ask someone to re-add the translation tags so the page is translatable again. @STei-WMF do you know what's the process for doing that?

@Tchanders I added a couple screenshots of the new logs we added. Looks all good to me.
We need to ask someone to re-add the translation tags so the page is translatable again. @STei-WMF do you know what's the process for doing that?

@Niharika the tags have been added already. (Thanks for this mention here though, my first task via Phab I think 💃🏻)