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.

Sign up for GitHub

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

Jump to bottom

d3: fix alpha URLs for 8.6 c8 REST API docs #4828

Merged
merged 2 commits into from
Jan 13, 2025
Merged

d3: fix alpha URLs for 8.6 c8 REST API docs #4828

merged 2 commits into from
Jan 13, 2025

Conversation

pepopowitz
Copy link
Collaborator

Targets the branch for #4799.

Description

  • Fixes the 8.6 C8 REST API docs, which were targeting an alpha document that moved in vNext.
  • Adjusts the C8 REST API generation strategy to vary its alpha document path by version, so that I don't have to fix this same issue when I generate the older versions.

There are still two broken links in the generated API docs

These are because the C8 REST docs reference an 8.5-specific document, which is not yet included in this branch. Eventually it will be, and those broken links should resolve.

image

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@pepopowitz pepopowitz added dx Documentation infrastructure typically handled by the Camunda DX team epic:docusaurus3 labels Jan 9, 2025
@pepopowitz pepopowitz self-assigned this Jan 9, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 9, 2025

👋 🤖 🤔 Hello, @pepopowitz! Did you make your changes in all the right places?

These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in docs/.

  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-document-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/download-document-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/find-all-users.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@pepopowitz pepopowitz mentioned this pull request Jan 9, 2025
Merged
43 tasks
@pepopowitz pepopowitz requested a review from akeller January 9, 2025 19:46
akeller
akeller approved these changes Jan 9, 2025
View reviewed changes
Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

Thank you 🙏

Is there a better/smarter way for us to catch these link changes? Or is that part of this, include a set of linked docs as part of the generation strategy and add more moving forward?

@pepopowitz
Copy link
Collaborator Author

Thank you 🙏

Is there a better/smarter way for us to catch these link changes? Or is that part of this, include a set of linked docs as part of the generation strategy and add more moving forward?

This is maybe not exactly what you're thinking. The URLs this PR corrects were actually introduced by the API doc generation process, they weren't snuck into the spec upstream.

So in this case, we already own these links, and the issue is that I didn't notice that I was using an invalid URL in #4805 and #4801.

@pepopowitz pepopowitz merged commit ce14e39 into pepopowitz/3736-docusaurus-lets-gooooo Jan 13, 2025
9 of 10 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/3736-docusaurus/fix-8-6-camunda-api branch January 13, 2025 21:28
pepopowitz added a commit that referenced this pull request Feb 6, 2025
@pepopowitz
upgrade: docusaurus 3!!! (#4799)
e6a61bd 
* d3: bump dependencies to minimum docusaurus 3.0

* d3: remove as many broken things as possible (#4800)

* temp: remove docLayoutComponent setting

* temp: remove old versions

* temp: remove broken theme components

* d3: remove configuration for older versions

* d3: regenerate vNext API docs (#4801)

* d3: regenerate camunda api docs, vNext

* d3: regenerate operate api docs, vNext

* d3: regenerate tasklist api docs, vNext

* d3: regenerate admin sm api docs, vNext

* fix: update badge removal regex and regen vNext API docs to scrub the duplicate badges

* d3: regen 8.6 API docs (#4805)

* feat: rewrite api generation to support older versions; configure v8.6 of operate API generation

* oops: remove notes

* fix: regenerate 8.6 operate api docs to accommodate updated plugin

* feat: configure 8.6 tasklist api generation

* fix: regenerate 8.6 tasklist api docs to accommodate updated plugin

* feat: configure 8.6 admin-sm api generation

* fix: regenerate 8.6 admin-sm api docs to accommodate updated plugin

* feat: configure 8.6 camunda api generation

* fix: regenerate 8.6 camunda api docs to accommodate updated plugin

* fix: revert id of sm-admin 8.6 info page

* feat: configure 8.6 zeebe api generation

* fix: regenerate 8.6 zeebe api docs to accommodate updated plugin

* d3: fix alpha URLs for 8.6 c8 REST API docs (#4828)

* fix: accommodate different alpha URLs per version in C8 REST docs

* fix: regen c8 REST docs for v8.6, with correct alpha URL.

* fix: adapt to change in react-prisma-renderer API

* d3: reintroduce 8.5 docs (#4872)

* d3: reintroduce 8.5 docs

* d3: configure 8.5 operate api docs

* d3: regenerate 8.5 operate api docs

* d3: configure 8.5 tasklist api docs

* d3: regen 8.5 tasklist api docs

* d3: configure 8.5 zeebe api docs

* d3: regen 8.5 zeebe api docs

* fix: remove unused image reference for file that doesn't exist

* fix: adapt to change in react-prisma-renderer API

* regenerate camunda/next api

* regen camunda api

* d3: reintroduce 8.4 docs (#4928)

* reintroduce 8.4 versions

* configure 8.4 operate api docs

* regenerate 8.4 operate api docs

* configure 8.4 tasklist api docs

* regenerate 8.4 tasklist api docs

* fix some broken links

* d3: reintroduce 8.3 docs (#4929)

* reenable 8.3 version

* fix dependency URL

* fix broken links

* remove obsolete config item

* bump to latest docusaurus (#4932)

* the curl icon is dead, long live the curl icon.

* d3: rewrite Metadata override (#4937)

* rewrite Metadata override

* add some guidance for pre-commit hook

* fix tests

* adjust archival theme component based on moved API

* re-introduce DocCard override
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akeller akeller akeller approved these changes

Assignees

@pepopowitz pepopowitz

Labels
dx Documentation infrastructure typically handled by the Camunda DX team epic:docusaurus3
Projects
Documentation Team
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pepopowitz @akeller