search

Pirate-Weather / pirateweather

Code and documentation for the Pirate Weather API
Apache License 2.0
643 stars 29 forks source link

Fix HTML on Terms page #299

Open mbomb007 opened 3 weeks ago

mbomb007 commented 3 weeks ago

Describe the issue

https://pirate-weather.apiable.io/terms

There is no guarantee that this service will:

Work when you try to use it Continue to work Produce accurate results Not do anything crazy Keep the same API key limits

It looks like the content should be an ordered or unordered list. However, it's just a single paragraph. The other sections are the same, having odd spacing (or lack thereof).

It would also be nice if the Terms would hyperlink to the privacy policy.

The privacy policy has similar formatting issues. https://pirate-weather.apiable.io/privacy

Acknowledgements

cloneofghosts commented 3 weeks ago

Thanks for reporting this! Only @alexander0042 has the ability to update these docs but it should now be on the radar to get these all fixed up.

The terms and conditions text seems to have been taken from the old getting started page before the docs were updated https://github.com/Pirate-Weather/pirateweather/blob/main/DevPortal/custom-content/content-fragments/GettingStarted.md#terms-and-conditions.

Also on the Privacy Policy page I see a bunch of links which takes you to a Termly page which you have to sign up for. I assume these are meant to be jump links to different sections on the page?

mbomb007 commented 3 weeks ago

Also on the Privacy Policy page I see a bunch of links which takes you to a Termly page which you have to sign up for.

For reference, this is the Table of Contents section, which isn't currently helpful, since it takes you to another website requiring a sign-up.

alexander0042 commented 3 weeks ago

Sometimes the fact that my background is civil engineering, not business (or computer science) is painfully obvious! I used an online generator for those, since I figured "these seem like the sorts of things I should include", but never stopped to check the formatting, so I'll fix it now!

For the record, the goal of the terms of service is to say: while this service has been around for a couple years and is broadly stable, glitches, incorrect data, or downtime may occur, and accordingly, unless we have a contract in place, there is no formal guarantee about the results.

Re: Privacy policy, the only data logged by the API is the latitude and longitude of the request. These get saved for 3 days to help with debugging, and are then flushed. Everything else is now handled by Apiable, and they have a wonderfully comprehensive privacy policy.

cloneofghosts commented 2 weeks ago

It's been a few days and while I see that it's mostly fixed there still are a few issues:

Terms of Service the Limitation of Liability section is one giant paragraph and is hard to read. The one in the getting started I linked to has a few paragraphs and another section.

The privacy page everything after the CCPA Privacy Notice still seems to have not been fixed yet.

cloneofghosts commented 1 week ago

@alexander0042 Just bumping this as a reminder to finish fixing both pages as I noticed that this still hasn't been fixed yet.