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

docs: lot of guides #4355

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: lot of guides #4355

wants to merge 2 commits into from

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Jan 13, 2025

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-3385

How to:

  1. Pick a guide in the google sheet
  2. Add a valid test case to the corresponding tests/CTS/requests/<CLIENT_NAME>/<METHOD_NAME>.json file
    a. Use a descriptive testName (see sheet for the snippet key column)
    b. Set isSnippet to true
  3. Generate the test case for your favorite API client: yarn cli cts generate python <CLIENT_NAME>
    a. The CI will do the generate for all of them
  4. Generate the snippet for your favorite API client, from your test case: yarn cli snippets python <CLIENT_NAME>
    a. The CI will do the generate for all of them
    b. The >SEPARATOR line in the added newly added snippet should reflect the test name, e.g. >SEPARATOR setSettings keywordSearch in snippets/python/search.py
  5. Finally, build the end JSON snippet file with yarn cli build specs search -d -s

@shortcuts shortcuts self-assigned this Jan 13, 2025
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jan 13, 2025

✔️ Code generated!

Name Link
🪓 Triggered by 91fa3515e313e8b1112a85fe3fbe832d3b197097
🍃 Generated commit 4eab5a92d0102800c758dee3824f8e1a9052f860
🌲 Generated branch generated/feat/guide-hackathon

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

Successfully merging this pull request may close these issues.

2 participants