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

Remove the "Install" section from the "Command-line quick start" guide. #362

Closed
marten-seemann opened this issue Jul 1, 2020 · 9 comments
Assignees
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours kind/maintenance Work required to avoid breaking changes or harm to project's status quo P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/docs Documentation

Comments

@marten-seemann
Copy link
Member

There are two Install guides on docs.ipfs.io: https://docs.ipfs.io/install/command-line-quick-start/ and https://docs.ipfs.io/how-to/command-line-quick-start/. They are slightly different, for example, the latter one instructs Mac users to download the x86 version, which is not supported by current OSX versions any more.

When installing IPFS that way, users will run into problems with OSX Gatekeeper, since the binary is not properly signed. Maybe we should recommend using Homebrew to install IPFS? Otherwise, we might want to add some text how to add an exception for the Gatekeeper.

@marten-seemann marten-seemann added the need/triage Needs initial labeling and prioritization label Jul 1, 2020
@johnnymatthews
Copy link
Contributor

johnnymatthews commented Jul 1, 2020

There's two issues here:

We have two quick-starts.

Let's delete the quick start under the How-tos section.

  • Delete the Quick Start section from How-tos.
  • File a PR with the infrastructure team to add a redirect /how-to/command-line-quick-start/ -> /install/command-line-quick-start/
  • Remove /how-to/command-line-quick-start/ from the sidebar.

IPFS has issues installing on macOS.

There are several ways around this. Using Homebrew as you suggest, or by grabbing the Go-IPFS binary with wget. Although I believe the binaries at dist.ipfs.io are signed. Would you be able to test this @marten-seemann?

@johnnymatthews johnnymatthews self-assigned this Jul 1, 2020
@johnnymatthews johnnymatthews added dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours kind/maintenance Work required to avoid breaking changes or harm to project's status quo P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/docs Documentation and removed need/triage Needs initial labeling and prioritization labels Jul 1, 2020
@marten-seemann
Copy link
Member Author

There are several ways around this. Using Homebrew as you suggest, or by grabbing the Go-IPFS binary with wget. Although I believe the binaries at dist.ipfs.io are signed. Would you be able to test this @marten-seemann?

Github and dist.ipfs.io seem to serve the same files. Checking again, it also looks like I only get the Gatekeeper warning for the 32-bit version, not the 64-bits.

@johnnymatthews
Copy link
Contributor

Thanks for checking in on that @marten-seemann. There likely needs to be a discussion around whether or not we should keep the 32-bit version. There's already an internal discussion on how to drop support (seems very simple), we just need to decide whether or not we should. I'll update this issue with more information once it comes out.

@johnnymatthews
Copy link
Contributor

I created an issue to discuss dropping 32-bit macOS support. The result of that discussion was to keep supporting 32-bit macOS, and fix the signing process, which spawned a new issue.

So, the second part of this issue, IPFS has issues installing on macOS, will be fixed by the new ipfs/distributions` issue #273. The first part of this issue, We have two quick-starts, still needs to be addressed.

@alexmmueller
Copy link
Contributor

I am wondering if this is a good issue for me to start contributing? I have a product background and surely have a learning curve in working with github, but would be happy to help here.

@johnnymatthews
Copy link
Contributor

johnnymatthews commented Sep 22, 2020

This issue has changed from when it was first created. The Install section of the Command-line quick start is a duplicate of the /install/command-line/ page, so it needs to be removed. However, the rest of the Command-line quick start guide is still useful.

Tasks

  • Remove the Install IPFS section from the Command-line quick start guide.
  • Add a prerequisites section to the Command-line quick start guide.
    • Instruct users to install Go-IPFS through the command-line if they haven't already.

Feel free to have a go at addressing these issues @alexmmueller. Fork this repository and make a PR against master once you have completed your work. I'll assign this issue to you.

@johnnymatthews johnnymatthews changed the title Issues with the quick install guide Remove the "Install" section from the "Command-line quick start" guide. Sep 22, 2020
@alexmmueller
Copy link
Contributor

Thank you @johnnymatthews, will do so.

@alexmmueller
Copy link
Contributor

Is there anything left to do for me here, or can the issue be closed?

@johnnymatthews
Copy link
Contributor

Nope, that's everything! Thanks for your contribution @alexmmueller!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours kind/maintenance Work required to avoid breaking changes or harm to project's status quo P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/docs Documentation
Projects
None yet
Development

No branches or pull requests

3 participants