votinginfoproject / vip-specification

The Voting Information Project XML specification.
http://vip-specification.readthedocs.io/en/release/
Other
75 stars 30 forks source link

Feature/issue 366 improve data rules best practice #393

Closed afsmythe closed 4 years ago

afsmythe commented 4 years ago

This PR relocates the "XML Best Practices" page from the XML page to a generic, top level (CSV/XML) Data Best Practice page. The impetus for this change is Issue https://github.com/votinginfoproject/vip-specification/issues/366 and, upon review of the existing documentation it was discovered that most of the relevant best practices were only visible within the XML sections. In order to make this more visible to CSV data providers we have relocated the best practices to a top level and made the language more generic with regards to data formats when appropriate.

Aside from the relocation mentioned above, the documentation updates include: