Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

meta-proposal: doc refactor #90

Open
jamesturk opened this issue May 30, 2017 · 2 comments
Open

meta-proposal: doc refactor #90

jamesturk opened this issue May 30, 2017 · 2 comments
Labels

Comments

@jamesturk
Copy link
Member

Right now this repo has:

  • somewhat halfhearted docs on how cities can adopt OCD as a format
  • docs on how to write a scraper with pupa
  • somewhat out-of-date descriptions of the various OCD types
  • OCDEPs
  • a Python style guide

I think in reconsidering the purpose of this repository it should have:

  • an intro page explaining what Open Civic Data is, who is involved, etc.
  • the canonical docs on each OCD type (updated as amended/created by OCDEPs)
  • OCDEPs

The "how cities can adopt OCD" stuff is stale and not worth keeping IMO. If the need arises I imagine we'd take a different approach now than what Sunlight was pursuing when those were started.

And the pupa docs should probably be moved to the pupa repository (& linked from the intro page)

If others are OK with this I'd like to start on this soon so that we can have Open States docs reference good OCD docs where appropriate

@jpmckinney
Copy link
Member

Sounds good to me! I only reference the OCDEPs.

@fgregg
Copy link
Contributor

fgregg commented Jun 3, 2017

agree!

@jpmckinney jpmckinney added the meta label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

3 participants