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

refactor (docs): Suggest update for installing iota binaries #5396

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

Ginowine
Copy link
Contributor

Description of change

I had an experience the first time I installed the IOTA binaries, and I felt the argument below should not be included in the main command because it confuses a first-timer. I ran the command several times to figure out that I did not need to include my OS and the architecture of the system.

<OS>-<ARCHITECTURE>

I also removed the --key-scheme argument when generating a new address using the iota client new-address command. The --key-scheme argument is not needed.
`

Links to any relevant issues

Type of change

  • Documentation Fix

How the change has been tested

All preview tests passed.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have checked that new and existing unit tests pass locally with my changes

@Ginowine Ginowine added dx-documentation For TW or documentation related issues. devx Issues related to the DevX team labels Feb 14, 2025
@Ginowine Ginowine requested a review from a team as a code owner February 14, 2025 11:40
Copy link

vercel bot commented Feb 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
apps-backend ⬜️ Ignored (Inspect) Feb 14, 2025 11:40am
apps-ui-kit ⬜️ Ignored (Inspect) Feb 14, 2025 11:40am
rebased-explorer ⬜️ Ignored (Inspect) Feb 14, 2025 11:40am
wallet-dashboard ⬜️ Ignored (Inspect) Feb 14, 2025 11:40am

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 14, 2025
@Ginowine Ginowine requested a review from vivekjain23 February 14, 2025 11:40
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview


Start a new terminal session or type source ~/.zshrc (or .bashrc) to load the new PATH value.

If you are running the binaries for the first time, you might receive an error from MacOS that prevents the binaries from running. If you receive this error, close the dialog and type xattr -d com.apple.quarantine ~/iota/* in your terminal and press Enter (be sure to adjust the path if different).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you are running the binaries for the first time, you might receive an error from MacOS that prevents the binaries from running. If you receive this error, close the dialog and type xattr -d com.apple.quarantine ~/iota/* in your terminal and press Enter (be sure to adjust the path if different).
If you are running the binaries for the first time, you might receive an error from MacOS that prevents the binaries from running. If you receive this error, close the dialog and type `xattr -d com.apple.quarantine ~/iota/*` in your terminal and press Enter (be sure to adjust the path if different).

Which error? Please add the specifics

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When you run the iota command the first time, it will show this. I also confirmed it from the Sui doc.

Screenshot 2025-02-14 at 13 43 12 Screenshot 2025-02-14 at 13 47 28

It will show this on Mac, and you need to go to privacy and security to allow it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Btw, we might want to wrap this in an admonition

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant that please add the error message to the docs. Instead of saying an error, you say you may receive an error stating that iota cannot .... btw, we should add a checksum or smt so the users can verify the downloaded binaries

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation dx-documentation For TW or documentation related issues.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants