sdk-for-python icon indicating copy to clipboard operation
sdk-for-python copied to clipboard

📚 Documentation: Mistake in code snippets in getting started guide

Open FloLan1 opened this issue 1 year ago • 18 comments

💭 Description

The code snippet for creating a user in the getting started guide throws an error due to an invalide phone number. This:

result = users.create('[USER_ID]', '[email protected]', 'password')

should be changed to:

result = users.create(ID.unique(), email = '[email protected]', phone = '+123456789', password = 'password', name = 'user1')

👀 Have you spent some time to check if this issue has been raised before?

  • [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

FloLan1 avatar Jun 15 '23 20:06 FloLan1

Hey there,

Thanks for reaching out. We appreciate you bringing this to our attention. Rest assured, we're aware of the issue, and we'll make sure to update it with the correct syntax. In the meantime, we recommend checking out our documentation, as it has been updated with the accurate examples you need. You can find them here: https://appwrite.io/docs/getting-started-for-server#makeRequest

If you have any further questions or need any assistance, feel free to ask

joeyouss avatar Jun 19 '23 13:06 joeyouss

It seems like this is the file that needs to be updated to fix this.

stnguyen90 avatar Sep 22 '23 17:09 stnguyen90

Hi @Haimantika, I would like to work on this issue, if it is up for grabs.

aniketh-varma avatar Oct 01 '23 18:10 aniketh-varma

Hi @Haimantika, I would like to work on this issue, if it is up for grabs.

Hi @aniketh-varma have assigned the issue to you! Thank you for showing interest in contributing to Appwrite! Happy Hacktoberfest 🎃

Notes:

Please update us with your progress every 3 days, so that we know that you are working on it. Join us on Discord - https://appwrite.io/discord to chat about Hacktoberfest and Appwrite!

Haimantika avatar Oct 02 '23 09:10 Haimantika

Hi @Haimantika , if the previous contributor is unresponsive, I would like to work on this issue then please assign it to me later on. Thanks!

GuptaPratik02 avatar Oct 03 '23 15:10 GuptaPratik02

Hi @Haimantika, just to confirm, if this is the file to be updated. Then the PR I would create would be for the appwrite repo and not the current sdk-for-python repo. Am I correct on this?

aniketh-varma avatar Oct 03 '23 19:10 aniketh-varma

Hi @Haimantika, there is NO update/changes seen from previous assignee in this issue since 4-5 days? Can you assign it to me? I will be quick and make a PR soon!

GuptaPratik02 avatar Oct 06 '23 07:10 GuptaPratik02

Hi @Haimantika, there is NO update/changes seen from previous assignee in this issue since 4-5 days? Can you assign it to me? I will be quick and make a PR soon!

Yes! @aniketh-varma we are reassigning the issue to the next person due to inactivity from your end. @GuptaPratik02 the issue is yours now

Haimantika avatar Oct 06 '23 07:10 Haimantika

Thanks @Haimantika, will update you by today!

GuptaPratik02 avatar Oct 06 '23 07:10 GuptaPratik02

hi @Haimantika , @stnguyen90 you can assign it to me incase @GuptaPratik02 is not able to finish it.

Gilbishkosma avatar Oct 06 '23 10:10 Gilbishkosma

Hi @Haimantika, I have checked the doc files that needs to be updated, I raised 2 PRs and made changes in 2 repositories doc file.

  1. First change I made in this repository's README file - Pull request 1
  2. Second change I made in appwrite repository's Getting_Started file - Pull request 2

Kindly check and review my PR. Thank you!

GuptaPratik02 avatar Oct 06 '23 13:10 GuptaPratik02

@Haimantika I was waiting for your reply on the query I had asked, the confusion being an issue for the appwrite repository was raised in this sdk-for-python repository. I have been participating in Hacktoberfests since 2019 and haven't seen such practices of reassignments in other projects to which I have contributed. This puts pressure on the assignee and defeats the entire purpose of Hacktoberfest, which is to encourage more contributions. Being a part of the contributor team of Appwrite since 2020 (the first time Appwrite had taken part in Hacktoberfest), I did not expect this, and reassigning issues without any confirmation from the current assignee is very wrong. I have been assigned many issues in other projects and I am given ample time to solve the issues without any 'deadline' pressure :)

aniketh-varma avatar Oct 06 '23 19:10 aniketh-varma

@Haimantika I was waiting for your reply on the query I had asked, the confusion being an issue for the appwrite repository was raised in this sdk-for-python repository. I have been participating in Hacktoberfests since 2019 and haven't seen such practices of reassignments in other projects to which I have contributed. This puts pressure on the assignee and defeats the entire purpose of Hacktoberfest, which is to encourage more contributions. Being a part of the contributor team of Appwrite since 2020 (the first time Appwrite had taken part in Hacktoberfest), I did not expect this, and reassigning issues without any confirmation from the current assignee is very wrong. I have been assigned many issues in other projects and I am given ample time to solve the issues without any 'deadline' pressure :)

With that much of experience, you should have read the appwrite rules on contributing during hacktoberfest brother... they clearly stated 3 days of inactivity could roll over issue to others. Atleast you could've opened a draft PR if it was taking time

prithvi2k2 avatar Oct 08 '23 00:10 prithvi2k2

@Haimantika I was waiting for your reply on the query I had asked, the confusion being an issue for the appwrite repository was raised in this sdk-for-python repository. I have been participating in Hacktoberfests since 2019 and haven't seen such practices of reassignments in other projects to which I have contributed. This puts pressure on the assignee and defeats the entire purpose of Hacktoberfest, which is to encourage more contributions. Being a part of the contributor team of Appwrite since 2020 (the first time Appwrite had taken part in Hacktoberfest), I did not expect this, and reassigning issues without any confirmation from the current assignee is very wrong. I have been assigned many issues in other projects and I am given ample time to solve the issues without any 'deadline' pressure :)

With that much of experience, you should have read the appwrite rules on contributing during hacktoberfest brother... they clearly stated 3 days of inactivity could roll over issue to others. Atleast you could've opened a draft PR if it was taking time

Thanks for the advice man. I appreciate Appwrite for abiding by the rules, but a simple confirmation before re-assigning the issue would be more courteous to the current assignee and would confirm the inactivity on the issue. I don't know if you've contributed to other projects, but the assignees are not pressurised to complete the issues within specific deadlines, threatening to roll over the issue to somebody else without confirming. For this issue, a draft PR would be the equivalent of a normal PR :)

aniketh-varma avatar Oct 08 '23 07:10 aniketh-varma

Hi @Haimantika, I have checked the doc files that needs to be updated, I raised 2 PRs and made changes in 2 repositories doc file.

  1. First change I made in this repository's README file - Pull request 1
  2. Second change I made in appwrite repository's Getting_Started file - Pull request 2

Kindly check and review my PR. Thank you!

Hi @Haimantika, can you acknowledge once that pull request I made is assigned to a maintainer to review?

GuptaPratik02 avatar Oct 09 '23 08:10 GuptaPratik02

@Haimantika I was waiting for your reply on the query I had asked, the confusion being an issue for the appwrite repository was raised in this sdk-for-python repository. I have been participating in Hacktoberfests since 2019 and haven't seen such practices of reassignments in other projects to which I have contributed. This puts pressure on the assignee and defeats the entire purpose of Hacktoberfest, which is to encourage more contributions. Being a part of the contributor team of Appwrite since 2020 (the first time Appwrite had taken part in Hacktoberfest), I did not expect this, and reassigning issues without any confirmation from the current assignee is very wrong. I have been assigned many issues in other projects and I am given ample time to solve the issues without any 'deadline' pressure :)

Hi @aniketh-varma apologies if you feel this way, that wasn't the intention at all. We wanted to give a fair chance to everyone to contribute. Since in the past we have had cases where people didn't work on an issue and others didn't get a chance to work on it either. I did react a thumbs-up on your query, I perhaps should have also dropped a message, and I apologise for that. We didn't want to put a deadline, we just wanted an update every 3 days. :)

Haimantika avatar Oct 11 '23 12:10 Haimantika

@Haimantika I would like to work on this. Can you assign it to me?

akash47angadi avatar Oct 15 '23 04:10 akash47angadi

@Haimantika I was waiting for your reply on the query I had asked, the confusion being an issue for the appwrite repository was raised in this sdk-for-python repository. I have been participating in Hacktoberfests since 2019 and haven't seen such practices of reassignments in other projects to which I have contributed. This puts pressure on the assignee and defeats the entire purpose of Hacktoberfest, which is to encourage more contributions. Being a part of the contributor team of Appwrite since 2020 (the first time Appwrite had taken part in Hacktoberfest), I did not expect this, and reassigning issues without any confirmation from the current assignee is very wrong. I have been assigned many issues in other projects and I am given ample time to solve the issues without any 'deadline' pressure :)

Hi @aniketh-varma apologies if you feel this way, that wasn't the intention at all. We wanted to give a fair chance to everyone to contribute. Since in the past we have had cases where people didn't work on an issue and others didn't get a chance to work on it either. I did react a thumbs-up on your query, I perhaps should have also dropped a message, and I apologise for that. We didn't want to put a deadline, we just wanted an update every 3 days. :)

Hey @Haimantika, I completely understand, that tracking the repos' issues, that too during the Hacktoberfest is a tedious task, and I really appreciate that Appwrite is abiding by the rules. I was just not happy about the reassignment of the issue without any confirmation from my end. There is no need for an apology, you are doing your work, I would just want to suggest, maybe a comment confirming the activity on an inactive issue may be a better alternative than just re-assigning. Thanks! 😄

aniketh-varma avatar Oct 24 '23 10:10 aniketh-varma