This repository has been archived
The documentation source can now be found under: https://github.com/ethersphere/swarm/tree/master/docs/swarm-guide
Swarm Documentation
Home Page: https://swarm-guide.readthedocs.io
This repository has been archived
The documentation source can now be found under: https://github.com/ethersphere/swarm/tree/master/docs/swarm-guide
make html
$GOPATH/src/github.com/swarm-guide/contents/apireference.rst:5: WARNING: Duplicate explicit target name: "npm".
$GOPATH/src/github.com/swarm-guide/contents/apireference.rst:5: WARNING: Duplicate explicit target name: "npm".
$GOPATH/src/github.com/swarm-guide/contents/apireference.rst:5: WARNING: Duplicate explicit target name: "github".
contents/usage/mru.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:4: WARNING: Content block expected for the "note" directive; none found.
contents/usage/mru.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:5: WARNING: Explicit markup ends without a blank line; unexpected unindent.
contents/usage/manifests.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:96: WARNING: Title level inconsistent:
Path Matching
^^^^^^^^^^^^^^
contents/usage/manifests.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:119: WARNING: Title level inconsistent:
Paths and directories
^^^^^^^^^^^^^^^^^^^^^
contents/usage/fuse.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:41: WARNING: Title level inconsistent:
Mount
^^^^^^^^
contents/usage/fuse.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:75: WARNING: Title level inconsistent:
Access
^^^^^^^^
contents/usage/fuse.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:79: WARNING: Title level inconsistent:
Unmount
^^^^^^^^
contents/usage/fuse.rst <included from $GOPATH/src/github.com/swarm-guide/contents/usage.rst>:92: WARNING: Title level inconsistent:
List Mounts
^^^^^^^^^^^^^^^^^^
$GOPATH/src/github.com/swarm-guide/contents/usage/bzz.rst:4: WARNING: duplicate
warning: duplicate label bzz protocol suite, other instance in $GOPATH/src/github.com/swarm-guide/contents/usage.rst
$GOPATH/src/github.com/swarm-guide/contents/usage/bzz.rst:74: WARNING: duplicate label bzz-raw, other instance in $GOPATH/src/github.com/swarm-guide/contents/usage.rst
$GOPATH/src/github.com/swarm-guide/contents/usage/ens.rst:4: WARNING: duplicate label ethereum name service, other instance in $GOPATH/src/github.com/swarm-guide/contents/usage.rst
$GOPATH/src/github.com/swarm-guide/contents/usage/mru.rst:4: WARNING: Content block expected for the "note" directive; none found.
$GOPATH/src/github.com/swarm-guide/contents/usage/mru.rst:5: WARNING: Explicit markup ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] usage/mru
$GOPATH/src/github.com/swarm-guide/contents/architecture.rst:268: WARNING: undefined label: bzz url schemes (if the link has no caption the label must precede a section header)
$GOPATH/src/github.com/swarm-guide/contents/architecture.rst:277: WARNING: undefined label: manifests (if the link has no caption the label must precede a section header)
$GOPATH/src/github.com/swarm-guide/contents/architecture.rst:280: WARNING: undefined label: bzz url schemes (if the link has no caption the label must precede a section header)
When trying to connect to this url It will loading for a long time and no response.
For the http and the command line API
@nolash please review the following documentation chapters:
Below is a list of criteria to give better guidelines on what we should look for when reviewing the documentation in order to focus efforts in the right direction.
--
Language criteria:
Design criteria:
Structure criteria:
Relationship criteria:
Content criteria:
Please submit all PRs to swarm-guide/docs-overhaul
branch.
If there are any blockers - please address them within the scope of this issue.
@justelad please review the following documentation chapters:
Below is a list of criteria to give better guidelines on what we should look for when reviewing the documentation in order to focus efforts in the right direction.
--
Language criteria:
Design criteria:
Structure criteria:
Relationship criteria:
Content criteria:
Please submit all PRs to swarm-guide/docs-overhaul
branch.
If there are any blockers - please address them within the scope of this issue.
dfn:
seen in text, should be control :dfn:
7.3.2
"pss methods are by default exposed via IPC. If websockets are activated on the node, they will also be available there if the pss module is explicitly specified."
As I see --pss is no longer needed as it's loaded automatically (atleast with --ws).
"pss methods are by default exposed via IPC. If websockets are activated on the node, they will also be available there."
see ethersphere/swarm-home#17
and the existing listing on swarm home
in manifests
there's the following example:
swarm --recursive --defaultpath orange-papers/index.html --bzzapi http://swarm-gateways.net/ up orange-papers/ 2> up.log
2477cc8584cc61091b5cc084cdcdb45bf3c6210c263b0143f030cf7d750e894d
where swarm --recursive --defaultpath orange-papers/index.html
uploads a single file, but it should probably be swarm --recursive --defaultpath orange-papers/
@nonsense please review the following documentation chapters:
Below is a list of criteria to give better guidelines on what we should look for when reviewing the documentation in order to focus efforts in the right direction.
--
Language criteria:
Design criteria:
Structure criteria:
Relationship criteria:
Content criteria:
Please submit all PRs to swarm-guide/docs-overhaul
branch.
If there are any blockers - please address them within the scope of this issue.
TBD review the following documentation chapters after other chapters have been done:
Below is a list of criteria to give better guidelines on what we should look for when reviewing the documentation in order to focus efforts in the right direction.
--
Language criteria:
Design criteria:
Structure criteria:
Relationship criteria:
Content criteria:
Please submit all PRs to swarm-guide/docs-overhaul
branch.
If there are any blockers - please address them within the scope of this issue.
If a naïve user follows the instructions of this section, she would encounter dependency problems while installing geth
. This would be helped by replacing go install
with go get
.
However, it might be better just to reference the corresponding part of geth
documentation rather than repeating it here.
In the section "running a private swarm" it's written that:
First you fire up a number of swarm instances, following the instructions above. You can keep the same datadir, since all node-specific info will reside under $DATADIR/bzz-$BZZKEY/ Just make sure that you create an account for each instance of swarm you want to run.
However, if you try to do this, you get the error:
Fatal: Error starting protocol stack: datadir already used by another process
Setting the --ipcpath
explicitly to a different ipc file does not help.
I presume the documentation's expectations here are wrong?
I run make html-docker
as per the documentation. It returns this error message:
Makefile:13: *** The 'sphinx-build' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the 'sphinx-build' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/. Stop.
@holisticode please review the following documentation chapters:
Below is a list of criteria to give better guidelines on what we should look for when reviewing the documentation in order to focus efforts in the right direction.
--
Language criteria:
Design criteria:
Structure criteria:
Relationship criteria:
Content criteria:
Please submit all PRs to swarm-guide/docs-overhaul
branch.
If there are any blockers - please address them within the scope of this issue.
--nodiscover
flag is not implemented anymore. This section needs to be updated to instruct how to manually control connection. It should also be made clearer that it doesn't give full control of connectivity, only of the boostrapping.
https://swarm-guide.readthedocs.io/en/latest/gettingstarted.html#adding-enodes-manually
It is not clear at the moment whether MRU is able to function in encrypted mode per description in:
https://github.com/ethersphere/swarm/wiki/Symmetric-Encryption-for-Swarm-Content
A small paragraph clarifying if yes/no, or any other details would be helpful.
@janos please review the following documentation chapters:
Below is a list of criteria to give better guidelines on what we should look for when reviewing the documentation in order to focus efforts in the right direction.
--
Language criteria:
Design criteria:
Structure criteria:
Relationship criteria:
Content criteria:
Please submit all PRs to swarm-guide/docs-overhaul
branch.
If there are any blockers - please address them within the scope of this issue.
http://swarm-guide.readthedocs.io/en/latest/usage.html
swarm up --bzzapi http://swarm-gateways.net /path/to/file/or/directory
returns error with swarm 1.5.6-unstable.
Incorrect Usage.
up [arguments...]
"upload a file or directory to swarm using the HTTP API and prints the root hash",
flag provided but not defined: -bzzapi
it worked with the command below by putting up
before the path
swarm --bzzapi http://swarm-gateways.net up /path/to/file/or/directory
either the document or the cli should be fixed.
I activated a virtualenv (Python 2.7.15rc1, pip 19.0.2). Then installed sphinx as per the documentation. Running make html
prints this error message:
Running Sphinx v1.8.4
Extension error:
Could not import extension sphinx_tabs.tabs (exception: No module named sphinx_tabs.tabs)
From reading docs, I understood that if I don't want to use ENS, but have a mutable address I can use feeds. This, fortunately, turned out to be true.
But I had to dig through some source code to find, what exactly needs to be published.
The answer: "0x1b20${hash}"
References:
sw3 games
wip - https://www.sharelatex.com/read/yszmsdqyqbvc
network
wip - https://www.sharelatex.com/read/gxhwssqzgfpr
our roadmap that we link to from the new documentation is out of date.
the last status updates are from 2017 and we should update it with relevant information for users to take seriously.
optionally we should link to our ethersphere project roadmap kanban board and make it publicly accessible with read-only permissions so that users could explore and see our progress in real-time.
At the top of the how-to-use-swarm section should be the default swarm connected to testnet paired with geth on ropsten.
Only later should we introduce the options of running your own network, singleton mode and the rest.
Many (most?) users start at the top of the documentation and work their way down.
I have already answered many questions from people somewhat lost with a --verbosity(6) --maxpeers(0) setup coming from the docs.
@gbalint please review the following documentation chapters:
Below is a list of criteria to give better guidelines on what we should look for when reviewing the documentation in order to focus efforts in the right direction.
--
Language criteria:
Design criteria:
Structure criteria:
Relationship criteria:
Content criteria:
Please submit all PRs to swarm-guide/docs-overhaul
branch.
If there are any blockers - please address them within the scope of this issue.
There is an inconsistency in the docs as to which data directory to use and where the keystore is.
If we start geth with --datadir=X --testnet then the actual datadir will be X/testnet.
Swarm on the other hand doe s not add a /testnet subdirectory so we will have to specify its datadir as X/datadir. Thus there is confusion because $DATADIR is not the datadir.
I suggest we do away with the variable $DATADIR entirely and just spell it out at /path/to/data/. It makes it easier to understand (but harder to copy-paste).
Also there is a difference between geth account new and geth --testnet account new!
Issue
path examples mostly come from Linux(?), intermediate mac users will be baffled.
examples (section):
Proposed solution
docs could use path variables all through (eg $DATADIR etc). section 2. could set them up in a table like this:
path | LINUX | macOS | etc |
---|---|---|---|
GOPATH | $HOME/go | $HOME/go | |
PATH | ... | ||
DATADIR | ... | ||
... | ... |
it could add that
The introduction and "basics" section in the documentation is too long and too complicated. We should cater for the reader who is wondering about how to migrate from web2 to web3, who should be able to read an overview in 5 minutes and understand most of what is written. With the current text, I don't think that's at all the case.
Ideally the swarm page would whet the apetite with slogan claims, the introduction/basics should elaborate briefly on key topics that are clearly labelled and recognizable from the homepage. Anything more elaborate should be in the architecture section.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.