ethersphere / bee-docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation for the Swarm Bee Client. View at docs.ethswarm.org, contributions welcome!
Home Page: https://docs.ethswarm.org
Documentation for the Swarm Bee Client. View at docs.ethswarm.org, contributions welcome!
Home Page: https://docs.ethswarm.org
(some of these might already be addressed)
API reference can be built from an Openapi YAML file like so:
openapi-generator generate -g markdown -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o .
This outputs the files to current working dir (replace .
with desired path).
The YAML file will come from the work done on documenting the API.
The problem to be solved currently is, how to properly "include" the markodown files, so all the links work properly.
The page https://docs.ethswarm.org/docs/installation/configuration (chapter configuration options
) shows certain default values (payment threshold
, payment tolerance
, swap-initial-deposit
) which are outdated.
The task is to go over all configuration options and bring it up-to-date with the most recent default values. Note. It may also be the case that some configuration options are missing and others are deprecated.
You can learn about the default configuration of a bee node by calling bee printconfig
Eg. the :
Should not disappear.
Therefore, add pinning into continious deployment. Also, if that not sufficent, include periodic reupload of the content (to keep it from getting garbage collected).
The menu button on half-screen or phone is not clearly visible
SWAP is not anymore an advanced topic in the view of rise of Bee.
And include it in the BOS deployment process.
Add link to Discord and remove the Beehive
This is an important step which is needed to participate in the rise of Bee campaign. Comms team can refer to this.
bee-clef-get-keys
As implemented in : ethersphere/bee#398
So that people can do PRs or add issues re the docs.
What is minimum go version number to build bee?
And deploy them to docs site (both web2 and web3).
The web3 ones should be tied to an ENS domain (e.g. api.swarm.eth for API reference doc).
Seems there is some string missing in the path, as the correct path would probably be:
https://github.com/ethersphere/docs.github.io/blob/master/docs/api-reference/api-reference.md
As a consumer of the bee documentation, I want that it always instructs me to download the latest version of anything I am instructed to install, such that I don't accidentally run obsolete software
This issue was made after finding out that the user is instructed to install bee-clef v4.1 in our docs, whereas bee-clef is already at v4.4. We need to inspect our docs, see where else there is a possibility of referring obsolete software and make the precautions to ensure that this won't happen again in the future.
It will probably be Matomo. Should be in sync with the webpage tracking.
Should contain pageview tracking if possible.
Also - an appropriate notice should be shown to the user, if tracking is turned on!
Make sure all the meta info / tags on docs site are updated as appropriate for project (not still the same as in template).
Start out by having all of the files to be uploaded in a single folder. This folder can contain any number of nested folders.
Then, collect all the content in a tarball by executing the tar
command, listing all of the files and directories in the folder that are to be included.
e.g. for:
my_website/
├── index.html
├── img/
├── fonts/
└── dist/
├── css/
└── js/
execute this from a terminal in my_website/
:
tar -cf <your_tarball_name>.tar img/ fonts/ dist/ index.html
Note that the tar
command must not be executed with a compression flag (such as -z
) otherwise it will not be read correctly.
Once there is a running bee
node, call the dirs
API to upload the tarball from the previous step:
curl -X POST -H "Content-Type: application/x-tar" --data-binary @<your_tarball_name>.tar http://localhost:8080/dirs
The application/x-tar
content type must be supplied for the upload to work.
This assumes the API port is 8080
.
If the upload is successful, a hash will be returned in response.
The content can be listed by querying the hash from the previous step through the files
API:
http://localhost:8080/files/<response_hash>
The files
API can also be used to directly query all of the content individually using the hash for each file.
However, the content can also be queried by name and relative path using the bzz
endpoint, like so:
http://localhost:8080/bzz/<response_hash>/<path_to_content>
Starting out with a folder that contains the following:
my_folder/
├── robots.txt
└── img/
├── 1.png
├── 2.png
└── 3.png
Create the tarball:
tar -cf my_folder.tar img/ robots.txt
Upload the tarball:
curl -X POST -H "Content-Type: application/x-tar" --data-binary @my_folder.tar http://localhost:8080/dirs
which results in the hash: e3d82e19d8521b377de7269085c91aab5ef113f45fd29ce79b8fd701029433a3
.
1.png
can be rendered directly in the browser by going to:
http://localhost:8080/bzz/e3d82e19d8521b377de7269085c91aab5ef113f45fd29ce79b8fd701029433a3/img/1.png
Use binary upload example in docs as it provides content-type in contrast to -F multipart upload (curl specific)
curl -H "Content-Type: text/plain" --data-binary @viktor.txt https://gateway.ethswarm.org/files?name=viktor.txt
https://docs.ethswarm.org/docs/getting-started/upload-and-download#quick-upload
It took me a while to guess the correct syntax for the bee.yaml file,
resolver-options: [ "https://cloudflare-eth.com" ]
Seems to need the square brackets? Anyway, it would also be nice if the doc recommended a test request such as,
http://localhost:1633/bzz/swarm.eth/
To keep get it running at computer start and keep it running.
The quickstart section is now somewhat all over the place, with different ways on how to install the bee node, links to bee-clef etc. We should have a look at how to re-organize the quickstart and let quickstart bee as easy as possible, while also linking the user to other resources in our docs.
Maybe even have to separate branches:
Create content based on defined content.
the name of this repo is very confusing.
i propose, in this order: bee-manual
or bee-manual-website
, or maybe docs.ethswarm.org
where it is available online.
bee-documentation
would suggest that it also contains internal, codebase related stuff, implementation decisions, coding guidelines, etc.
if it's decided and becomes actionable, then i'm willing to look into the details of the process. IIRC github will keep redirects that keep even fetching and pushing functional using the old repo urls, and redirects the web browser upon visiting the old url.
The quickstart section is now somewhat all over the place, with different ways on how to install the bee node, links to bee-clef etc. We should have a look at how to re-organize the quickstart and let quickstart bee as easy as possible, while also linking the user to other resources in our docs.
After subdomain is decided on, setup everything for it.
Can swarm content reside on a subdomain?
With the aim to redirect the users to the new site.
Preplay video in browser, instead of downloading.
curl -v -H "Content-Type: video/mp4" --data-binary @bbb_sunflower_1080p_30fps_normal.mp4 "https://gateway.staging.ethswarm.org/files?name=bbb_sunflower_1080p_30fps_normal.mp4
https://gateway.staging.ethswarm.org/files/f8a17811e72578e7b94758ba5cac37bd70278e71cf02866faf2d4dcc433272d9
(can attempt to be exhaustive, but at least what we want for Bee alpha release)
a convenient way to install the latest bee (macOS version, similar for linux):
wget https://github.com/ethersphere/bee/releases/latest/download/bee-darwin-amd64 -O /usr/local/bin/bee
chmod +x /usr/local/bin/bee
should be included in docs?
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.