Skip to content

Welcome Readme + other docs distributed #580

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

Closed
10 tasks done
jbenet opened this issue Jan 15, 2015 · 8 comments
Closed
10 tasks done

Welcome Readme + other docs distributed #580

jbenet opened this issue Jan 15, 2015 · 8 comments
Assignees
Milestone

Comments

@jbenet
Copy link
Member

jbenet commented Jan 15, 2015

We should include several simple docs in a small hash

  • readme - the welcome message
  • contact our contact info
  • help lists some helpful resources
  • security-notes see below
  • docs a directory of ipfs docs themselves!

The readme (previously, the welcome message):

  • should move to ipfs cat <simple-docs>/readme
  • it should include a warning label (see below)
  • it should let users know about -h and --help in all commands
  • it should no longer direct people to ipfs tour
  • remove tour from command registry
 ---------------------------------------------------------------
| Warning: this is alpha software - use at your own discretion! |
| To read the security notes by enter:                          |
|   ipfs cat <hash>/security-notes                              |
 ---------------------------------------------------------------

the contact doc should include:

Contact the ipfs dev team:
- Bugs: https://github.com/jbenet/go-ipfs/issues
- Help: irc.freenode.org/#ipfs
- Email: [email protected]

The security-notes doc should be:

                    IPFS Alpha Security Notes

We try hard to ensure our system is safe and robust, but all software 
has bugs, specially new software. This distribution is meant to be an 
alpha preview, don't use it for anything mission critical.

- this is alpha software and has not been audited. it is our goal
  to conduct a proper sec audit once we close in on a 1.0 release.

- ipfs is a networked program, and may have serious vulnerabilities.
  It is written in Go, and we do not exec.Cmd any user provided data.
  But please point any problems out to us in a github issue, or email
  [email protected] privately.

- ipfs uses encryption for all comm, but it's NOT PROVED SECURE YET! 
  It may be totally broken. For now, the code is included to make sure 
  we benchmark our operations with encryption in mind. In the future, 
  there will be an "unsafe" mode for high performance intranet apps. 
  If this is a blocking feature for you, please contact us.

- We hash and sign all our releases. <include description of how to
  check distribution here>
@jbenet jbenet modified the milestones: alpha, α Jan 15, 2015
@jbenet jbenet self-assigned this Jan 15, 2015
@whyrusleeping
Copy link
Member

I think that all these files should be in the same directory, and the hash for that directory should be listed in the 'welcome' file that ipfs init tells you to cat.

@jbenet
Copy link
Member Author

jbenet commented Jan 17, 2015

I think that all these files should be in the same directory, and the hash for that directory should be listed in the 'welcome' file that ipfs init tells you to cat.

Yep! agreed!

@whyrusleeping
Copy link
Member

is [email protected] a mailing list? or a single email account?

@jbenet
Copy link
Member Author

jbenet commented Jan 17, 2015

@whyrusleeping it will be a mailing list and you will be on it.

@whyrusleeping
Copy link
Member

I can tackle adding all of these files if youre busy with other things.

@jbenet
Copy link
Member Author

jbenet commented Jan 20, 2015

@whyrusleeping sure go for it. I think we should put all of these under a dir like this in our codebase:

assets
└── init-doc
    ├── contact
    ├── docs
    │   └── index
    ├── help
    ├── readme
    └── security-notes

2 directories, 5 files

i kicked it off at: master...init-docs

@whyrusleeping
Copy link
Member

Were going to want to have all the text embedded in the binary. So the working copies can be in assets, and ill work on a makefile that will generate go source files with constants for the text.

@jbenet jbenet added the hack label Jan 24, 2015
@jbenet jbenet assigned jbenet and unassigned whyrusleeping Jan 26, 2015
@jbenet jbenet mentioned this issue Jan 30, 2015
@jbenet
Copy link
Member Author

jbenet commented Jan 31, 2015

Fixed in #639

@jbenet jbenet closed this as completed Jan 31, 2015
ariescodescream pushed a commit to ariescodescream/go-ipfs that referenced this issue Oct 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants