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

📚 Documentation: Queries tutorial #77

Closed
2 tasks done
gewenyu99 opened this issue Sep 27, 2023 · 12 comments
Closed
2 tasks done

📚 Documentation: Queries tutorial #77

gewenyu99 opened this issue Sep 27, 2023 · 12 comments
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@gewenyu99
Copy link
Contributor

💭 Description

Appwrite Databases has many different query methods.

While we have this page: /docs/products/databases/queries, but this is a reference, not a tutorial. There are also not enough examples.

Goal

Interactive examples in a tutorial format to introduce Apwrite's many query methods.

Content

  1. Server SDK/CLI script to set up an example database with test data.
  2. A page with one or many examples for each query method.
  3. Written in Node.js
  4. Added to src/routes/docs/tutorials

How to contribute

Pitch an outline detailing each page you plan to add and headings within, and ask to be assigned. Open a PR after the outline has been approved.

The Appwrite team will collaborate with you on the outline and PR.

Thanks for taking the time to make our documentation better 🙏

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

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@gewenyu99 gewenyu99 added the documentation Improvements or additions to documentation label Sep 27, 2023
@Susmita-Dey
Copy link

Susmita-Dey commented Oct 3, 2023

Hey @gewenyu99 I wanna take up this issue. Kindly assign it to me.

Here's an outline of the tutorial guide:

  • Introduction
    • Brief overview of Appwrite's query methods.
  • Setting Up Example Database
    • Provide code snippets to set up a sample database using Server SDK/CLI script.
  • Query Methods Examples
    • Method 1: Query Method 1 Explanation
      • Example code in Node.js.
      • Explanation of the example.
    • Method 2: Query Method 2 Explanation
      • Example code in Node.js.
      • Explanation of the example.
    • Other methods and examples in the same way

@Haimantika
Copy link
Contributor

Hey @gewenyu99 I wanna take up this issue. Kindly assign it to me.

Here's an outline of the tutorial guide:

  • Introduction

    • Brief overview of Appwrite's query methods.
  • Setting Up Example Database

    • Provide code snippets to set up a sample database using Server SDK/CLI script.
  • Query Methods Examples

    • Method 1: Query Method 1 Explanation

      • Example code in Node.js.
      • Explanation of the example.
    • Method 2: Query Method 2 Explanation

      • Example code in Node.js.
      • Explanation of the example.
    • Other methods and examples in the same way

Hi, this issue is not a part of hacktoberfest.

@Susmita-Dey
Copy link

Hey @Haimantika I know that. I just want to contribute.

@gewenyu99
Copy link
Contributor Author

@Susmita-Dey You know what, we can make this part of Hacktoberfest. It was removed because it was a large scope that could be too difficult. But I know you've been in our community for a long time and have experience. I'll let you have a go and mark it for Hacktoberfest, too!

Lmk if you need help, this one might be tough!

Feel free to post frequent updates!

@soumwadeep
Copy link

Can I Also Contribute In It?

@soumwadeep
Copy link

My Outline Will Go Like This
Introduction

  • Brief overview of Appwrite Databases query methods
  • How to use query methods to filter, sort, and paginate results
  • Different types of query methods available
  • Benefits of using query methods

Setting Up Example Database

  • Code snippets to set up a sample database using Server SDK/CLI script
  • Creating a database
  • Creating a collection
  • Inserting some test data

Query Methods Examples

Method 1: equal()

  • Explanation of the equal() method
  • Example code in Node.js
  • Explanation of the example

Method 2: notEqual()

  • Explanation of the notEqual() method
  • Example code in Node.js
  • Explanation of the example

Method 3: lessThan()

  • Explanation of the lessThan() method
  • Example code in Node.js
  • Explanation of the example

Please Assign Me If Possible @Haimantika @gewenyu99

@soumwadeep
Copy link

@Haimantika Can I Be Assigned?

@gewenyu99
Copy link
Contributor Author

@soumwadeep This has already been assigned, we assign on a first come first server basis :D

@soumwadeep
Copy link

ok sir

@Susmita-Dey
Copy link

Update: Work in progress

@shivanshu814
Copy link

Can I Also Contribute In It? @gewenyu99

@tessamero tessamero linked a pull request Nov 2, 2023 that will close this issue
@tessamero
Copy link
Contributor

@Susmita-Dey do you plan to continue to work on your draft PR? Please send a follow up so the PR doesn't get closed. =]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants