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

chore: keep guides for docs close to snippets #3354

Merged
merged 2 commits into from
Jul 12, 2024

Conversation

shortcuts
Copy link
Member

🧭 What and Why

🎟 JIRA Ticket:

Changes included:

since the split of the CI, the generation of the snippets is done outside of the release step, but the website generated folder isn't pushed to the repo, see https://github.com/algolia/api-clients-automation/actions/runs/9908119385/job/27373697603

since this folder will disappear when the algolia doc leverages our snippets, we can already move our snippet guides in a dedicated folder that we push and keep code in, so the release step can also leverage it

@shortcuts shortcuts self-assigned this Jul 12, 2024
@shortcuts shortcuts requested a review from a team as a code owner July 12, 2024 13:26
@shortcuts shortcuts requested review from morganleroi and millotp July 12, 2024 13:26
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jul 12, 2024

✔️ Code generated!

Name Link
🪓 Triggered by b7a7143d361ee554e9826ad43a71a529df933138
🍃 Generated commit c70e7744ec79bfd21ca846b65605c1d9f3d9b313
🌲 Generated branch generated/chore/codegen-snippets-docs

@millotp
Copy link
Collaborator

millotp commented Jul 12, 2024

I think you need to update snippet.js in the website, or remove it entirely

@shortcuts
Copy link
Member Author

I think you need to update snippet.js in the website, or remove it entirely

I've ignored it on purpose, it still works but will be removed in a week or so, so... it's fine for now I guess

@millotp
Copy link
Collaborator

millotp commented Jul 12, 2024

if the files are not generated nor commited it will fail right ? with a import not found error

Copy link

@shortcuts
Copy link
Member Author

if the files are not generated nor commited it will fail right ? with a import not found error

since the build docs steps is in the same as the website build I think it's fine, even if it's not committed it still has access to it directly

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

ah yes okay I thought you moved the generated folder too

@shortcuts shortcuts merged commit 258df91 into main Jul 12, 2024
21 checks passed
@shortcuts shortcuts deleted the chore/codegen-snippets-docs branch July 12, 2024 13:49
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