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: finalize rename of console sm api to administration sm api #4793

Merged
merged 6 commits into from
Dec 19, 2024

Conversation

pepopowitz
Copy link
Collaborator

Description

In #4162, we renamed some generated assets from console sm to administration sm (or similar), but we didn't update the sources that generate them.

This PR completes that renaming.

This will help me in the docusaurus 3 upgrade, because it will allow me to regenerate docs for this API with minimal noise.

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 component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team theme:hygiene Issues related to the theme of hygiene labels Dec 18, 2024
@pepopowitz pepopowitz self-assigned this Dec 18, 2024
Copy link
Contributor

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

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

  • docs/apis-tools/administration-sm-api/administration-sm-api-overview.md
  • docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx
  • docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx
  • docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx
  • docs/apis-tools/administration-sm-api/specifications/sidebar.js

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.

Comment on lines +158 to +159
title: Administration API (Self-Managed)
description: Access the administration API of Console Self-Managed.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@urbanisierung is there an upstream repository where I can duplicate these changes, so that they don't get overwritten in a future spec update?

@pepopowitz
Copy link
Collaborator Author

Since this is mostly infrastructural, I'm merging it without review, so that I can move forward with the docusaurus 3 upgrade. I will address any feedback in follow-up PRs.

@pepopowitz pepopowitz merged commit 8c44107 into main Dec 19, 2024
8 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/finish-admin-sm-rename branch December 19, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team theme:hygiene Issues related to the theme of hygiene
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

1 participant