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

github-action: Add AsciiDoc freeze warning #3959

Merged

Conversation

reakaleek
Copy link
Member

Details

⚠️ This PR was created by an automated tool. Please review the changes carefully. ⚠️

Add a workflow that will comment on PRs with AsciiDoc changes.

Why

During the migration to Elastic Docs v3, the Docs team will focus exclusively on migrating content.
To maintain consistency, prevent conflicts, and ensure a smoother transition we will freeze all AsciiDoc changes.

This means you will get a warning when you create AsciiDoc changes in your PRs.

See elastic/docs-builder#281 for details

If there are any questions, please reach out to the @elastic/docs-engineering

@JonasKunz
Copy link
Contributor

Our changelog is stored in an aciidoc file, too. That one cannot be frozen, as it would prevent us from releasing IINM?

Also how long will the migration take, as it will essentially block us from updating docs, right? Or is there an alternate process?

@reakaleek
Copy link
Member Author

reakaleek commented Jan 29, 2025

Our changelog is stored in an aciidoc file, too. That one cannot be frozen, as it would prevent us from releasing IINM?

Also how long will the migration take, as it will essentially block us from updating docs, right? Or is there an alternate process?

Generally, the check is not a required status check. Hence, you can ignore it if necessary.

For the timeline, I'm gonna share on slack.

@SylvainJuge SylvainJuge merged commit 9d16386 into elastic:main Feb 3, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants