search

openaustralia / planningalerts

Find out and have your say about what's being built and knocked down in your area.
https://www.planningalerts.org.au
Other
95 stars 51 forks source link

Update "Get the Data" section #1782

Closed katska closed 1 month ago

katska commented 8 months ago

Update "Get the Data"

This is the beginning of a big overhaul. First series of changes aim to:

katska commented 8 months ago

the part about non-commercial use being available can included later in the section that's currently labelled usage

katska commented 6 months ago

I'm bringing quite a few updates, many changes are coming to "Get the Data to clarify our offerings. Some of these need more work before we can do that. The first step in our timeline is to introduce a 2 week trial, and reframe the broader introduction to what's commercial and what's free.

alrighty this is where I get specific....

In the first paragraph, replace:

Non–commercial, low–volume use of this service is free. Read more.

with

Sign up for a 14-day free trial of our API to seamlessly integrate Planning Alerts data into your projects. Get your API key today and explore our services with a rate limit of about 1000 requests per day. First read our terms of use

Next, please replace

Low volume, non–commercial use of the API service is free. We ask that personal and non–profit use of this service attribute the OpenAustralia Foundation on your website or application.

Standard agreements for commercial use are at oaf.org.au/standard-agreements/planningalerts-commercial. Please contact us for commercial use. Commercial users may include Real Estate Agencies, Architects, Planners or Builders.

Also, please get in touch if you intend to use the service on a large scale. In order to maintain quality of service for our API users, this service is rate limited by default to approximately 1000 requests per day.

We offer a range of paid options, from rate–limited to unlimited use of this service.

with

Apply for Ongoing Access

Enjoy uninterrupted access by signing up before your trial ends. Our current standard agreement applies for continued access to the service.

If you have a clear community public purpose and are unfunded, you might qualify for a grant to access our API for free or at a reduced cost for community public purpose. Please get in touch

katska commented 6 months ago

so I think we can also ask the community purpose people to agree to terms and sign the agreement and make a different schedule either instead of or a variation on the payment.

One question for me remains, whether we put additional terms for community public purpose access at the end of the agreement or in a separate place?

katska commented 6 months ago

@mlandauer It's important to make changes to set reasonable expectations of use for this service. If the new page suggested seems like too much change requiring decisions there's not headspace to make right now, please can you make the following changes in support of

Changes are as follow for a minimum viable next step:

1- remove this part

Low volume, non–commercial use of the API service is free. We ask that personal and non–profit use

2- Replace with the following:

Sign up for a 14-day free trial of our API to seamlessly integrate Planning Alerts data into your projects. Get your API key today and explore our services with a rate limit of about 1000 requests per day. We require that all users

3 - Remove "Low volume, non–commercial use of the API service is free. We ask that personal and non–profit use of this service attribute the OpenAustralia Foundation on your website or application. "

4- Remove "Also, please get in touch if you intend to use the service on a large scale. In order to maintain quality of service for our API users, this service is rate limited by default to approximately 1000 requests per day."

5 - Add Please get in touch for ongoing access to the API."

6 - Make Usage and Be Nice all one section. I can advise on switching the sentences around to flow, or have a go yourself.

katska commented 4 months ago

Turns out minimum viable content change doesnt require wording around a two week trial, and with all the evolution above, now looks like this:

Get your API key today and explore our services with an initial rate limit of about 20 requests per day for evaluation purposes. If you need more, please contact us

Please get in touch for ongoing access to the API.

If you have a clear community public purpose and are unfunded, you might qualify for a grant to access our API for free or at a reduced cost. Please ask us about this

Attribution and a link to the Planning Alerts API are required on your website or application, or where ever you use the data.

katska commented 3 months ago

@JoannaHill @mlandauer can we workshop what changes we can commit to on this page in the short term please?

JoannaHill commented 3 months ago

Yes.

I can do a mock up of the text changes you're suggesting above. Where on the page would this go and should I be removing all the example calls?

JoannaHill commented 3 months ago

@katska You've made some other wording suggestions in Figma to this page. Lets regroup over there for fleshing out. Can Andy be given Figma access too?

https://www.figma.com/design/GEaOuajueHGvfaFPsOUZ9n?node-id=2663-325#600588808 https://www.figma.com/design/GEaOuajueHGvfaFPsOUZ9n?node-id=2663-325#887313287

katska commented 3 months ago

@JoannaHill I find it quite hard to follow updates in figma and communicate a path when there are complex pieces as there are here, and the team is asynchronous and remote. And, I don't have admin access to figma so you or Matthew may need to add Andy.

katska commented 3 months ago

Let's move this to google docs and use the parts that feel useful based on where we're going now see figma board. When the bits are in google docs we can close this.

katska commented 3 months ago

@JoannaHill it looks like @blikantt still doesn't have figma access, and I don't have permissions so unable to help. There is a recent discussion here which is relevant to #1473

JoannaHill commented 1 month ago

Get the data section now called Planning Alerts API and includes major overhaul of information on the page. Including separting off Developer Documentation and making the landing page more of a sales page. See live site.