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

api.md: direct TOC links to new publicapi docs location #12175

Merged
merged 1 commit into from
May 20, 2024

Conversation

catzkorn
Copy link
Member

This change updates the existing api.md TOC links to point at the new publicapi folder/files. It also removes the body of the docs from the file, to avoid the docs becoming out of sync.

This change also renames overview.md to readme.md.

Updates tailscale/corp#19526

Copy link
Member

@soniaappasamy soniaappasamy left a comment

Choose a reason for hiding this comment

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

Ty!

publicapi/device.md Show resolved Hide resolved
```

Delete a posture attribute from the specified device. This is only applicable to user-managed posture attributes in the `custom` namespace, which is indicated by prefixing the attribute key with `custom:`.
- Get a device: [`GET /api/v2/device/{deviceid}`](./publicapi/device.md#get-device)
Copy link
Member

Choose a reason for hiding this comment

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

The relative linking works here right? For some reason GitHub mobile won't let me try myself

Copy link
Member

Choose a reason for hiding this comment

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

they're not working consistently, but they weren't really working before either. It's an issue on GitHub's side, so I think this is fine for now.

Copy link
Member

Choose a reason for hiding this comment

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

well, maybe not. hmph. Some of them were working before, but definitely not now. But I do still remember have a lot of issues with consistent anchor linking on GitHub, so I'm not too worried about it.

Copy link
Member

Choose a reason for hiding this comment

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

oh hmph yaaa

We could replace them all with static long links I guess

Copy link
Member

Choose a reason for hiding this comment

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

But hopefully we don't stick with the readme file for too much longer anyways

api.md Outdated Show resolved Hide resolved
This change updates the existing api.md TOC links to point at the new
publicapi folder/files. It also removes the body of the docs from the
file, to avoid the docs becoming out of sync.

This change also renames overview.md to readme.md.

Updates tailscale/corp#19526

Signed-off-by: Charlotte Brandhorst-Satzkorn <charlotte@tailscale.com>
@soniaappasamy soniaappasamy merged commit 4f4f317 into main May 20, 2024
47 checks passed
@soniaappasamy soniaappasamy deleted the catzkorn/api.md branch May 20, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants