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

request: run C8 REST API synchronization process for any version #4961

Open
pepopowitz opened this issue Feb 7, 2025 · 1 comment
Open
Assignees
Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/feature Issues related with features to be documented theme:api-streamline Issues related to the theme of streamlining APIs

Comments

@pepopowitz
Copy link
Collaborator

Currently the C8 REST API sync process only runs against the camunda/camunda main branch, to update the next version of the docs.

#4956 will add confusion to this, since we will be managing two sets of next docs. When that lands, the sync process will run for version 8.8, but not 8.7.

To avoid mistakes and confusion, we could alter the sync-rest-api-docs workflow to accept an input parameter, specifying the version to synchronize.

Implementation notes

@pepopowitz pepopowitz added dx Documentation infrastructure typically handled by the Camunda DX team kind/feature Issues related with features to be documented theme:api-streamline Issues related to the theme of streamlining APIs labels Feb 7, 2025
@pepopowitz pepopowitz self-assigned this Feb 7, 2025
@github-project-automation github-project-automation bot moved this to 🆕 Inbox in Documentation Team Feb 7, 2025
@pepopowitz pepopowitz moved this from 🆕 Inbox to 🔖 Ready in Documentation Team Feb 7, 2025
@pepopowitz
Copy link
Collaborator Author

See #4979 for a concern re: sidebars files in non-next versions. There will be some faffing we need to do to copy the generated sidebars file back up to the top-level sidebars JSON file, replacing only a subtree of it. Blech.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/feature Issues related with features to be documented theme:api-streamline Issues related to the theme of streamlining APIs
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant