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

Update docs to reflect Plural Open and other updates #75

Merged
merged 1 commit into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/api-v2/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# GraphQL API
# DEPRECATED - GraphQL API

As of [December 1, 2023, the v2/GraphQL API has been sunset](https://blog.openstates.org/2023-june-changes/). Please
migrate to the [v3 API](https://docs.openstates.org/api-v3/) as soon as possible. Future service for the GraphQL API
is not guaranteed.

The rest of this documentation is left up for reference.

- API keys are required. You can [register for an API key](https://openstates.org/api/register/) and once activated,
you'll pass your API key via the `X-API-KEY` header.
Expand Down
2 changes: 1 addition & 1 deletion docs/api-v3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ access state legislative information.
The root URL for the API is <https://v3.openstates.org/>.

API keys are required. You can [register for an API
key](https://openstates.org/accounts/profile/) and once activated,
key](https://open.pluralpolicy.com/accounts/profile/) and once activated,
you\'ll pass your API key via the `X-API-KEY` header or `?apikey` query
parameter.

Expand Down
19 changes: 16 additions & 3 deletions docs/contributing/openstates-org.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# Working On openstates.org
# History of open.pluralpolicy.com / openstates.org

openstates.org is the public-facing result of all the work we do. The
site is built in Django and includes the web frontend and API.
open.pluralpolicy.com is the public-facing web app that has historically provided free democracy tools, API key registration,
and access to bulk data. However, we are in the process of migrating functionality into the main Plural application.
The Plural application provides continued [free legislative research and tracking tools](https://pluralpolicy.com/app/legislative-tracking)
as well as the ability to [Find Your Legislators](https://pluralpolicy.com/open/). The Plural app is not open source,
because our business model to support continued free democracy tools and expanded open data depends on providing
premium policy intelligence features to organizational customers.

For now, open.pluralpolicy.com will continue to provide a subset of related features:

- Register and manage your API key
- Bulk data downloads
- v2 of the API until is taken out of service (already deprecated, so please use the [v3 API](https://v3.openstates.org/docs)

The application is built in Django. Even after migration is complete, we will keep the repository up for anyone who
is interested in the open source code. The rest of this documentation is maintained here for reference.

## Checking out

Expand Down
6 changes: 3 additions & 3 deletions docs/contributing/writing-a-committee-scraper.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
* Store the data in the required format


## For those new to Open States:
- [What is Open States?](https://docs.openstates.org/#about-open-states)
## For those new to Plural Open / Open States:
- [What is Plural Open?](https://docs.openstates.org/#about-plural-open)
- [What is an open source project?](https://opensource.com/resources/what-open-source)
- [How do you contribute to Open States?](https://docs.openstates.org/contributing/#getting-started)
- [How do you contribute to Plural Open?](https://docs.openstates.org/contributing/#getting-started)
- What projects are we looking for contributions on?
* [Committee Scrapers](https://github.com/openstates/issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+scraper%22)
* [Other issues](https://github.com/openstates/issues/issues)
Expand Down
40 changes: 22 additions & 18 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
# Introduction

Welcome to the Documentation for Open States. The sections below cover contributing to scrapers & data, and how to use the API.
Welcome to the Documentation for the Plural Open Data project (formerly Open States). The sections below cover
contributing to scrapers & data, and how to use the API.

## About Open States
## About Plural Open

Open States strives to improve civic engagement at the state level by providing data and tools regarding state legislatures. We aim to serve members of the public, activist groups, journalists, and researchers with better data on what is happening in their state capital, and to provide tools to reduce barriers to participation and increase engagement.
Plural Open strives to improve civic engagement at the state level by providing data and tools regarding state
legislatures. We aim to serve members of the public, activist groups, journalists, and researchers with better data on
what is happening in their state capital, and to provide tools to reduce barriers to participation and increase
engagement.

The project aggregates legislative information from all 50 states, Washington, D.C., and Puerto Rico. This information is then standardized, cleaned, and published to the public via OpenStates.org, a powerful API, and bulk downloads.
The project aggregates legislative information from all 50 states, Washington, D.C., and Puerto Rico. This information
is then standardized, cleaned, and published to the public via PluralPolicy.com/open, a powerful API, and bulk
downloads.

All of this work is [done in the open](https://github.com/openstates/), and depends heavily on contributors striving to make this important resource available. Thank you for your interest in our community, whether you are looking to use our bulk data or APIs or interested in contributing data or code, we're glad to have you here.
This work was begun as the [Open States project and has a long history](https://open.pluralpolicy.com/about/). We moved
the work under [Plural Open in 2023](https://blog.openstates.org/2023-june-changes/).

Our open data work is [done in the open](https://github.com/openstates/), and depends in part on contributors to make
this
important resource available. Thank you for your interest in our community, whether you are looking to use our bulk data
or APIs or interested in contributing data or code, we're glad to have you here.

## Communication

Expand All @@ -26,29 +38,21 @@ but it may sometimes take a bit of time to get back to you.
**Want to ask a general question, have a conversation, or keep up with
the community?**

The best place is our [Discussion Forum](https://github.com/openstates/issues/discussions). This is the
main place for Open States discussion. The core team and many other
contributors are present there, and we're usually able to answer
questions in a timely fashion.
We have a Matrix chat space that you [can join if you're
interested in being a part of the community](https://matrix.to/#/#open-states:matrix.org). The
Matrix space (similar to Slack) is a good way to raise an emergency issue (API seems down, etc.)
or ask questions about how to get involved/contribute.

**Have a private question, or a security concern?**

Email <[email protected]>; only the administrative team can see these.
Email <[email protected]>; only the administrative team can see these.

**Have you found an error or issue in the Open States data?** **Have a
technical issue not related to the data itself?**

File an issue on [our bug tracker](https://github.com/openstates/issues/issues).
And before you do, quickly check whether anyone else there has already reported the same bug.

**Want to contribute to the project more regularly?**

We also have a Slack that you can join. It is not the best place for
asking questions better handled by filing an issue or opening a
conversation on GitHub, but you're welcome to [join if you're
interested in being a part of the
community](https://join.slack.com/t/open-states/shared_invite/zt-njrpuaoi-JP0bROOFtZLdtNHN3LsuFg).

### Discouraged Methods of Communication

Please *avoid* using these channels to get in touch with us:
Expand Down
Loading