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

rename console sm to admin sm #4162

Merged
merged 7 commits into from
Aug 23, 2024
Merged

rename console sm to admin sm #4162

merged 7 commits into from
Aug 23, 2024

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Aug 15, 2024

Description

Renames Console SM to Administration Self-Managed. Additional minor API tidying here and there.

To do

  • Add redirects.
  • Add new APIs to API overview page? Maybe a backlog issue, though should be complete before 8.6.

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/).

@christinaausley christinaausley added the component:docs Documentation improvements, including new or updated content label Aug 15, 2024
@christinaausley christinaausley self-assigned this Aug 15, 2024
Copy link
Contributor

👋 🤖 🤔 Hello! 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.5/.

  • docs/apis-tools/administration-sm-api/administration-sm-api-authentication.md
  • docs/apis-tools/administration-sm-api/administration-sm-api-overview.md
  • docs/apis-tools/administration-sm-api/sidebar-schema.js
  • 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
  • docs/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx
  • docs/apis-tools/camunda-api-rest/specifications/sidebar.js
  • docs/apis-tools/console-sm-api/console-sm-api-overview.md
  • docs/apis-tools/console-sm-api/sidebar-schema.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.

@christinaausley
Copy link
Contributor Author

christinaausley commented Aug 15, 2024

@pepopowitz I'm unfamiliar with the specifications setup -- can you have a look over my redirects?

static/.htaccess Outdated Show resolved Hide resolved
Co-authored-by: Steven Hicks <[email protected]>
@christinaausley christinaausley requested review from a team, akeller and theburi August 21, 2024 19:35
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

For the update/rename, this looks good! I wonder if discussing or breaking out issues for the following might be helpful:

  • use of JSON notation (not terribly important)
  • adding a link or otherwise describing/distinguishing between the SaaS and SM admin APIs, just for clarity

but neither of these need to hold up this PR. 👍

title: "Authentication"
sidebar_position: 2
description: "Console SM API is a REST API and provides access to Console SM data. Requests and responses are in JSON notation."
description: "The Administration API for Self-Managed is a REST API and provides access to Console Self-Managed data. Requests and responses are in JSON notation."
Copy link
Contributor

Choose a reason for hiding this comment

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

If we use this sort of phrasing elsewhere in the docs, it might be good to standardize on JSON vs JSON notation, but this isn't blocking for this PR.

Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

💪

@christinaausley
Copy link
Contributor Author

Merging this within the scope of the original issue.

use of JSON notation (not terribly important)
adding a link or otherwise describing/distinguishing between the SaaS and SM admin APIs, just for clarity

@conceptualshark feel free to create backlog items for these -- you can assign them to yourself or to me, either is fine!

@christinaausley christinaausley merged commit 6e66e6a into main Aug 23, 2024
11 checks passed
@christinaausley christinaausley deleted the rename-console-sm-api branch August 23, 2024 14:34
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
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants