BeoCode/Weather
BeoCode/Weather
Archived
6
0
Fork 11
Code Issues 17 Pull requests Releases 16 Wiki Activity

Update README with API breaking changes info #51

Merged
Beowulf merged 1 commit from jman/Weather:main into main 2022-10-25 18:27:57 +02:00
Conversation 7 Commits 1 Files changed 1 +2
jman commented 2022-10-25 12:08:15 +02:00
Contributor
Copy link

Hello @beocode

following up on my comment on issue #34, here's a small proposal to update the README to warn new users that the Weather App won't work out of box.

I think this warning can be removed when the API connection part will be rewritten to use another API but for the time being it is important to warn new users and old users creating new API keys (?).

In addition to this small README change I'd edit the wiki page "Get Started" as shown in my wiki fork.

This small patch is intended to relieve you from the pressure of new users piling up on this issue caused by OWN.

What do you think? Please feel free to adjust wording as you can see fit. Thanks for a review!

Hello @beocode following up on my comment on issue [#34](https://codeberg.org/BeoCode/Weather/issues/34#issuecomment-656695), here's a small proposal to update the README to warn *new users* that the Weather App won't work out of box. I think this warning can be removed when the API connection part will be rewritten to use another API but for the time being it is important to warn new users and old users creating new API keys (?). In addition to this small README change I'd edit the wiki page "Get Started" as shown in [my wiki fork](https://codeberg.org/jman/Weather/wiki/Home). This small patch is intended to relieve you from the pressure of new users piling up on this issue caused by OWN. What do you think? Please feel free to adjust wording as you can see fit. Thanks for a review!
Beowulf 2022-10-25 12:28:07 +02:00
Beowulf self-assigned this 2022-10-25 12:28:21 +02:00
Beowulf commented 2022-10-25 12:34:30 +02:00
Owner
Copy link

Can you check your GPG signature because you signed your commit but with a GPG key that Codeberg does not know.
Maybe something is wrong with your git config, or you forgot to add your public key in the settings.

Can you check your GPG signature because you signed your commit but with a GPG key that Codeberg does not know. Maybe something is wrong with your git config, or you forgot to add your public key in the settings.
Beowulf commented 2022-10-25 13:28:47 +02:00
Owner
Copy link

Otherwise it looks good, I would maybe just move it further up that it is more visible. Maybe it would be better directly above "Features" (line 18).

Otherwise it looks good, I would maybe just move it further up that it is more visible. Maybe it would be better directly above "Features" (line 18).
jman force-pushed main from 9a4dc35e59
All checks were successful
ci/woodpecker/pr/woodpecker Pipeline was successful
Details
to 65a840b193
All checks were successful
ci/woodpecker/pr/woodpecker Pipeline was successful
Details
2022-10-25 13:49:54 +02:00 Compare
jman commented 2022-10-25 13:51:32 +02:00
Author
Contributor
Copy link

ah thanks for noticing my incomplete setup (I had to setup a Codeberg account just to contribute to your project 😄)

I've amended the commit as per your suggestion. I will then update the wiki.

thanks

ah thanks for noticing my incomplete setup (I had to setup a Codeberg account just to contribute to your project :smile:) I've amended the commit as per your suggestion. I will then update the wiki. thanks
Beowulf approved these changes 2022-10-25 16:15:31 +02:00
Beowulf left a comment
Owner

Thanks for your contribution and that you even created an account for it.
That you have "jman@localhost" as your email in Git is so you don't publicize your mail? If so then I will merge your merge request.

Thanks for your contribution and that you even created an account for it. That you have "jman@localhost" as your email in Git is so you don't publicize your mail? If so then I will merge your merge request.
jman commented 2022-10-25 18:27:08 +02:00
Author
Contributor
Copy link

yes please feel free to merge, this tiny contribution is not worth any special recognition 🙃

yes please feel free to merge, this tiny contribution is not worth any special recognition 🙃
jman commented 2022-10-25 18:33:43 +02:00
Author
Contributor
Copy link

The wiki edit I'm afraid will be on you, I think I have no permissions to edit it (am not very familiar with Codeberg, so maybe I'm missing something). For reference, my suggestion is here.

thanks again

The wiki edit I'm afraid will be on you, I think I have no permissions to edit it (am not very familiar with Codeberg, so maybe I'm missing something). For reference, my suggestion [is here](https://codeberg.org/jman/Weather/wiki/Home). thanks again
Beowulf commented 2022-10-25 18:41:11 +02:00
Owner
Copy link

Updated the wiki, but removed the reference to OneCallApi 3.0, as OCA3 does not work, as these are different routes.
Thanks again for your contribution. (https://codeberg.org/BeoCode/Weather/wiki/Contributors)

Updated the wiki, but removed the reference to OneCallApi 3.0, as OCA3 does not work, as these are different routes. Thanks again for your contribution. (https://codeberg.org/BeoCode/Weather/wiki/Contributors)
👍 1
Commenting is not possible because the repository is archived.
Reviewers
No reviewers
Beowulf
Labels
Clear labels   
IMPORTANT
  
bug

   
critical bug

   
design

   
Doing

   
duplicate

   
enhancement

   
external bug

   
feature request

   
feedback

   
help needed

   
not reproducible

   
support

   
to do

   
translation

   
waiting for response
No labels
IMPORTANT
bug
critical bug
design
Doing
duplicate
enhancement
external bug
feature request
feedback
help needed
not reproducible
support
to do
translation
waiting for response
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
Beowulf
2 participants
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
BeoCode/Weather!51
No description provided.