Skip to content

docs: generate guides from snippets #3139

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

Merged
merged 56 commits into from
Jun 10, 2024
Merged

docs: generate guides from snippets #3139

merged 56 commits into from
Jun 10, 2024

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Jun 5, 2024

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-2429 https://algolia.atlassian.net/browse/DI-2409 https://algolia.atlassian.net/browse/DI-1632 https://algolia.atlassian.net/browse/APIC-679

Changes included:

provide the snippet methods directly in the docs guides, so you can generate a guide for all clients, in one go

todo:

  • update all mustache to include the import separator
  • add a waitTask helper to generate a wait for the snippet
  • avoid using e2e tests index names for snippets
  • update all guides

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jun 5, 2024

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@millotp millotp changed the title Feat/generate guides feat(doc): generate guides from snippets Jun 5, 2024
@millotp millotp changed the title feat(doc): generate guides from snippets docs: generate guides from snippets Jun 5, 2024
Copy link

github-actions bot commented Jun 6, 2024

@github-actions github-actions bot temporarily deployed to pull request June 6, 2024 08:04 Inactive
@github-actions github-actions bot temporarily deployed to pull request June 6, 2024 08:39 Inactive
@github-actions github-actions bot temporarily deployed to pull request June 6, 2024 09:01 Inactive
@github-actions github-actions bot temporarily deployed to pull request June 6, 2024 10:20 Inactive
Base automatically changed from docs/cleanup-guides to main June 6, 2024 13:54
@shortcuts shortcuts marked this pull request as ready for review June 10, 2024 10:53
@shortcuts shortcuts requested a review from a team as a code owner June 10, 2024 10:53
@shortcuts shortcuts requested review from damcou and Fluf22 June 10, 2024 10:53
@github-actions github-actions bot temporarily deployed to pull request June 10, 2024 13:22 Inactive
@github-actions github-actions bot temporarily deployed to pull request June 10, 2024 14:41 Inactive
@github-actions github-actions bot temporarily deployed to pull request June 10, 2024 15:37 Inactive


</TabsLanguage>
${waitForTaskSnippet()}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be waitForAppTaskSnippet but let's tackle this in another PR

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because its only used for dict, should we call it waitForDictionary ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure maybe we missed some use cases, let's keep the legacy name for safety

@github-actions github-actions bot temporarily deployed to pull request June 10, 2024 16:37 Inactive
@shortcuts shortcuts merged commit d03970b into main Jun 10, 2024
26 checks passed
@shortcuts shortcuts deleted the feat/generate-guides branch June 10, 2024 18:46
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.

3 participants