Skip to content

[Arduino Cloud] Cloud Agent Mini-article #1738

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

Merged
merged 3 commits into from
Mar 6, 2024

Conversation

karlsoderby
Copy link
Contributor

What This PR Changes

  • Very brief article explaining the cloud agent, and how to install it

Contribution Guidelines

Copy link

github-actions bot commented Feb 6, 2024

docs-content

🚀 Preview this PR: https://6581a377.docs-content.pages.dev
📍 Commit SHA: 69eff5e

Copy link

github-actions bot commented Feb 6, 2024

docs-content

🚀 Preview this PR: https://cbe1edfd.docs-content.pages.dev
📍 Commit SHA: 6d03978

@jhansson-ard jhansson-ard added the arduino Bugs and fixes added by the Arduino Team label Feb 6, 2024
@jhansson-ard
Copy link
Contributor

Just a thought, maybe we should link to this HC article explaining the download process as well?
https://support.arduino.cc/hc/en-us/articles/360014869820-Install-the-Arduino-Create-Agent

cc @seaxwi

@karlsoderby
Copy link
Contributor Author

Sure thing, I added the link at the end of the article in a section called troubleshooting.

@jacobhylen
Copy link
Contributor

I'm not sure if I think this is the right approach.
I believe there is a need for this information on docs, but I don't like the idea of having the same/very similar content in two places. It will be difficult to maintain and confusing for users.

Maybe we can move the article from HC to docs, or create a dummy article on docs that we redirect to the HC one so there is an entry point from docs?

@jhansson-ard
Copy link
Contributor

I agree, the information should be in one place - not duplicated. Did you check with @seaxwi when writing the article? Perhaps he has some ideas as well.

For the "entry point", where do we intend users to face this issue most? Perhaps we can link the HC article on the Cloud page?

@karlsoderby
Copy link
Contributor Author

@jacobhylen @jhansson-ard definitely best in one place, however in this case I don't mind it existing in two places because it is only a couple of paragraphs, and the HC article needs to set the context for what the Cloud Agent is.

Either way, I need to add this to the docs as it is a very important element of the cloud, and for the flow of the documentation. So I suggest let's go ahead and merge and then discuss with @seaxwi later if we want to update the HC article.

@jacobhylen jacobhylen self-assigned this Feb 8, 2024
@karlsoderby karlsoderby merged commit 462c0ce into main Mar 6, 2024
@karlsoderby karlsoderby deleted the karlsoderby/create-agent-docs branch March 6, 2024 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arduino Bugs and fixes added by the Arduino Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants