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: Reorg session recording operations #3483

Merged
merged 5 commits into from
Jul 26, 2023

Conversation

Dan-Heath
Copy link
Contributor

@Dan-Heath Dan-Heath commented Jul 19, 2023

During Boundary Docs Day, we added some new content to the session recording topics for Validating recordings and Validating the data store. We added them to the Operations topic, since this is ongoing work a user may be required to perform after initial setup. But I think they actually warrant their own topics, and would be easier to find if we put them on the TOC.

This PR performs a minor reorganization of the Operations topics for session recording. It creates a new Overview sub-topic, and breaks out the two validation topics to be standalone (I did not rewrite anything, this is just moving pieces of content around):

image

I changed the title of the section for validating data in the external store from "Validate the data integrity in the external object store" to "How Boundary validates data integrity in the external object store," since the user doesn't perform any action in that topic.

There were also some unrelated Docs Day updates to the Manage session recordings topic to add additional instructions for viewing and downloading recordings. Since this PR moves the validation sections out of that topic, and the remaining content focuses on finding and viewing recordings, I'd also like to change the topic title to Find and view recorded sessions, which I think is more descriptive than Manage session recordings.

These changes should make it easier to find this session recording content via the TOC and search (both from within the help system and external searches thanks to improved SEO).

View the update in the preview deployment.

Partially verified

This commit is signed with the committer’s verified signature.
Tofel’s contribution has been verified via SSH key.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
@Dan-Heath Dan-Heath added the backport/website Backport changes to `stable-website` and the latest release-branch label Jul 20, 2023
@Dan-Heath Dan-Heath marked this pull request as ready for review July 20, 2023 16:28
Copy link
Collaborator

@stellarsquall stellarsquall left a comment

Choose a reason for hiding this comment

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

I like this approach, and this it improves discoverability and usability 👍

@AdamBouhmad
Copy link
Contributor

Looks great -- super clear re-org. Thank you @Dan-Heath!!

@Dan-Heath Dan-Heath merged commit 1f6e000 into main Jul 26, 2023
@Dan-Heath Dan-Heath deleted the dheath-reorg-session-recording-operations branch July 26, 2023 15:27
stellarsquall pushed a commit that referenced this pull request Jul 28, 2023
* docs: Reorg session recording operations

* docs: Improve linking and meta content

* docs: Add redirect for old "Manage" topic

* docs: Updates to data store validation topic

* docs: Fix link name in index topic
mikemountain pushed a commit that referenced this pull request Aug 3, 2023
* docs: Reorg session recording operations

* docs: Improve linking and meta content

* docs: Add redirect for old "Manage" topic

* docs: Updates to data store validation topic

* docs: Fix link name in index topic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/website Backport changes to `stable-website` and the latest release-branch website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants