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

Add API key page #3845

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Add API key page #3845

merged 3 commits into from
Jan 15, 2025

Conversation

npentrel
Copy link
Collaborator

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jan 13, 2025
@npentrel npentrel requested a review from JessamyT January 13, 2025 17:44
Copy link
Collaborator

@JessamyT JessamyT left a comment

Choose a reason for hiding this comment

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

LGTM % Instead of adding this as a true new IA heading, another option would be putting it in the build reference section or in dev tools and linking to it where relevant. My thought is that "API keys" isn't a JTBD/imperative mood thing like all the other non-reference headings here (exception being SDKs which is just a link).


To edit an API key, click on **Show details** in the key's row of the key table's **Resources** column.

{{<imgproc src="/fleet/additional-details.png" resize="700x" declaredimensions=true alt="Additional details for a key">}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we care that this shows the ID without a box over it? Not sure why that would matter without the key but just wondering how much we care about setting precedents and whether readers will wonder whether we meant to include it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I see this more as showing an example of what the the UI looks like rather than to show exactly where to find the button. So I think it's ok but if you want to add a box, that's fine too.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I meant a redaction box--a solid grey box over the ID. Fine to leave if you're okay with it; just wanted to point it out in case we don't want to do this.

@npentrel
Copy link
Collaborator Author

npentrel commented Jan 15, 2025

LGTM % Instead of adding this as a true new IA heading, another option would be putting it in the build reference section or in dev tools and linking to it where relevant. My thought is that "API keys" isn't a JTBD/imperative mood thing like all the other non-reference headings here (exception being SDKs which is just a link).

Yes, I mentioned this option on slack, too. We can move it there if it feels like to much where it is now. I placed it with building apps as that is where it is relevant and it may be that that is where people would search for that information. If you want it to be in reference you can move it there, just look out for people who struggle to find that information, if that is the case move it back here.

I will merge this for now to remove the broken links (after fixing the remaining ones)

@viambot
Copy link
Member

viambot commented Jan 15, 2025

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3845

@npentrel npentrel merged commit d0d3a3a into viamrobotics:main Jan 15, 2025
9 checks passed
@npentrel npentrel deleted the api-keys branch January 15, 2025 14:23
Copy link

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)'

@JessamyT
Copy link
Collaborator

Yes, I mentioned this option on slack, too. We can move it there if it feels like to much where it is now. I placed it with building apps as that is where it is relevant and it may be that that is where people would search for that information. If you want it to be in reference you can move it there, just look out for people who struggle to find that information, if that is the case move it back here.

I will merge this for now to remove the broken links (after fixing the remaining ones)

Ah that's right, you did--sorry I should've phrased differently. Sounds good--will leave where it is for now and will change if it becomes clear that it is one too many headings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants