-
Notifications
You must be signed in to change notification settings - Fork 188
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
Conversation
👋 🤖 🤔 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/.
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 I'm unfamiliar with the specifications setup -- can you have a look over my redirects? |
Co-authored-by: Steven Hicks <[email protected]>
There was a problem hiding this 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." |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💪
Merging this within the scope of the original issue.
@conceptualshark feel free to create backlog items for these -- you can assign them to yourself or to me, either is fine! |
Description
Renames Console SM to Administration Self-Managed. Additional minor API tidying here and there.
To do
8.6
.When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).