Update Cloud API key creation instructions for new site design #1614
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
bug
karlsoderby
approved these changes
Dec 20, 2023
The Arduino Cloud website was recently redesigned. Before the redesign, API keys were managed by selecting "API keys" from the navigation panel on the Arduino Cloud home page. That item was removed from the navigation panel and there is now a dedicated page for managing API keys. This means the instructions based on the old design are no longer correct. The new design allows us to point the user directly to the relevant page rather than sending them to the home page and then instructing them in how to navigate to the key management interface. That navigation process is slightly more complex with the new design so continuing with the previous approach of starting from the home page would require adding an additional step to the instructions.
The previous links redirected to the Arduino Cloud home page. Perhaps they were broken by changes to the website since the time the content was written.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Arduino Cloud website was recently redesigned. Before the redesign, API keys were managed by selecting "API keys" from the navigation panel on the Arduino Cloud home page.
That item was removed from the navigation panel and there is now a dedicated page for managing API keys. This means the instructions based on the old design are no longer correct.
What This PR Changes
The outdated instructions for getting to the Arduino Cloud API key management interface are updated for the new Arduino Cloud site design.
The new design allows us to point the user directly to the relevant page rather than sending them to the home page and then instructing them in how to navigate to the key management interface. That navigation process is slightly more complex with the new design so continuing with the previous approach of starting from the home page would require adding an additional step to the instructions.
Some of the existing links to the "API Keys" page were broken, redirecting to the Arduino Cloud home page instead of the intended target. Those are updated to point to the current URL of the page.
Additional Context
This approach of directing the user to the "API Keys" page was already in use in some of the content:
docs-content/content/arduino-cloud/01.guides/07.node-red/nodered-intro.md
Line 184 in aa7c281
docs-content/content/arduino-cloud/07.api/01.api-overview/api-overview.md
Line 16 in aa7c281
docs-content/content/arduino-cloud/07.api/01.api-overview/api-overview.md
Line 16 in aa7c281
An update of a graphic is also required but I'm not set up for that so I was not able to include that in this PR. I submitted an issue to track the task: #1615
Originally reported at https://forum.arduino.cc/t/api-key-generation-page-not-available-on-home-screen/1200517
Contribution Guidelines