Add the keyword "MDM" to API endpoint docs #19029
Conversation
zwass
changed the title
|
Hey @zwass! Thanks for submitting this PR. When you get the chance, can you please help @rachaelshaw and I understand what the motivation is here? We want to be consistent. If the motivation is that it's unclear which API endpoints require turning on MDM, then we should make this change or a similar change elsewhere. |
|
Ooh, that is totally unclear. Overall, I find our API docs to be really hard to work with and it being unclear which features need to be turned on is definitely a problem. That's not the goal here though. Here it's a matter of trying to figure out how to do MDM actions (eg. set configuration profiles) via API. Check out this Loom for a recreation of what the process looked like: https://www.loom.com/share/25dc03235ab84f73b6e029db477870e0?sid=63818de6-cb8c-4207-baa1-cddfbf9b2a7b |
|
@zwass would you make an issue about the problems you're seeing with the API docs? Going to go ahead and close this since it sounds like this requires more thought about the overall doc structure, and changing 1 heading won't necessarily solve it. |
|
@rachaelshaw I will make a new issue, but why not merge this PR which will improve the experience in the meantime and take only a few seconds? |
|
@zwass we made this change fairly recently, moving MDM endpoints out of a single section that was kind of difficult to navigate— so really, there are a lot of sections that pertain to MDM, not just OS Settings. We should communicate that in a consistent way, but not sure adding "(MDM)" to the end of all the section headers is the way we want to go about that; think it could use a bit more thought before we change h3s. (Doing so breaks links, so best to do it sparingly.) |
|
@rachaelshaw #16728 looks like a regression to me given my recent experience of trying to actually use the docs to answer a question for a customer. I filed #19229. |
No description provided.