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

docs: expandable content feedback from users #48644

Open
mmcallister opened this issue Nov 8, 2024 · 1 comment · May be fixed by #49782
Open

docs: expandable content feedback from users #48644

mmcallister opened this issue Nov 8, 2024 · 1 comment · May be fixed by #49782
Assignees

Comments

@mmcallister
Copy link
Contributor

We've gotten periodic feedback about content being hidden and missed in the expandable sections. Some examples:

the two sections about security best practices and shell completion are hidden in collapsible section, which is not obvious at first. Consider removing the collapsible/detail markdown directive. (/docs/reference/cli/)

Going forward, we shouldn't put content like warnings, best-practices, or similar important details in expandable sections as it could be missed.

what ports and address does the agent need? e.g. how to lock down outbound connections from agents to proxy (/docs/reference/networking/)

For this one, the info is there but it is hidden at first; it’s the only piece on the page presented in a collapsible section.

@mmcallister mmcallister self-assigned this Nov 8, 2024
@mmcallister mmcallister changed the title docs: Expandable content feedback from users docs: expandable content feedback from users Nov 8, 2024
@mmcallister
Copy link
Contributor Author

For the first, the content is from includes snippet permission-warning.mdx and is using the html <details> tag, which specifies additional information that the user can open and close on demand. We can use <Details open> instead to keep formatting but not force people to click to see it.

Here are the pages this is used:

admin-guides/access-controls/getting-started.mdx:19:(!docs/pages/includes/permission-warning.mdx!)
admin-guides/api/getting-started.mdx:25:(!docs/pages/includes/permission-warning.mdx!)
admin-guides/management/admin/trustedclusters.mdx:172:(!docs/pages/includes/permission-warning.mdx!)
enroll-resources/application-access/getting-started.mdx:47:(!docs/pages/includes/permission-warning.mdx!)
enroll-resources/kubernetes-access/register-clusters/static-kubeconfig.mdx:15:(!docs/pages/includes/permission-warning.mdx!)
enroll-resources/server-access/getting-started.mdx:45:(!docs/pages/includes/permission-warning.mdx!)
enroll-resources/server-access/guides/recording-proxy-mode.mdx:44:(!docs/pages/includes/permission-warning.mdx!)
enroll-resources/server-access/guides/ssh-pam.mdx:56:(!docs/pages/includes/permission-warning.mdx!)
includes/kubernetes-access/helm/teleport-cluster-prereqs.mdx:6:(!docs/pages/includes/permission-warning.mdx!)
reference/architecture/api-architecture.mdx:29:(!docs/pages/includes/permission-warning.mdx!)
reference/cli/cli.mdx:15:(!docs/pages/includes/permission-warning.mdx!)

@mmcallister mmcallister linked a pull request Dec 4, 2024 that will close this issue
@mmcallister mmcallister linked a pull request Dec 4, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant