docs: move document from /docs to d7y.io (dragonflyoss#1229)

Signed-off-by: Gaius <[email protected]>

.github/workflows/lint.yml

@@ -28,4 +28,4 @@ jobs:
         with:
           config: '.markdownlint.yml'
           args: '**/*.md'
-          ignore: 'deploy/helm-charts manager/console CHANGELOG.md docs/en/api-reference docs/zh-CN/api-reference docs/en/cli-reference/dfget.1.md'
+          ignore: 'deploy/helm-charts manager/console CHANGELOG.md build'

Makefile

@@ -162,7 +162,7 @@ build-rpm-dfget: build-linux-dfget
 	@echo "Begin to build rpm dfget"
 	@docker run --rm \
 	-v "$(PWD)/build:/root/build" \
-	-v "$(PWD)/docs:/root/docs" \
+	-v "$(PWD)/build/package/docs:/root/docs" \
 	-v "$(PWD)/LICENSE:/root/License" \
 	-v "$(PWD)/CHANGELOG.md:/root/CHANGELOG.md" \
 	-v "$(PWD)/bin:/root/bin" \
@@ -179,7 +179,7 @@ build-deb-dfget: build-linux-dfget
 	@echo "Begin to build deb dfget"
 	@docker run --rm \
 	-v "$(PWD)/build:/root/build" \
-	-v "$(PWD)/docs:/root/docs" \
+	-v "$(PWD)/build/package/docs:/root/docs" \
 	-v "$(PWD)/LICENSE:/root/License" \
 	-v "$(PWD)/CHANGELOG.md:/root/CHANGELOG.md" \
 	-v "$(PWD)/bin:/root/bin" \
@@ -193,7 +193,7 @@ build-deb-dfget: build-linux-dfget
 
 # Generate dfget man page
 build-dfget-man-page:
-	@pandoc -s -t man ./docs/en/cli-reference/dfget.1.md -o ./docs/en/cli-reference/dfget.1
+	@pandoc -s -t man ./build/package/docs/dfget.1.md -o ./build/package/docs/dfget.1
 .PHONY: build-dfget-man-page
 
 # Generate e2e sha256sum

README.md

@@ -25,16 +25,17 @@ file distribution system. Its goal is to
 tackle all distribution problems in cloud native scenarios.
 Currently Dragonfly focuses on being:
 
-- Simple: well-defined user-facing API (HTTP), non-invasive to all container engines;
-- Efficient: CDN support, P2P based file distribution to save enterprise bandwidth;
-- Intelligent: host-level speed limit, intelligent flow control due to host detection;
-- Secure: block transmission encryption, HTTPS connection support.
+- **Simple**: Well-defined user-facing API (HTTP), non-invasive to all container engines;
+- **Efficient**: CDN support, P2P based file distribution to save enterprise bandwidth;
+- **Intelligent**: Host-level speed limit, intelligent flow control due to host detection;
+- **Secure**: Block transmission encryption, HTTPS connection support.
 
-Dragonfly is now hosted by the Cloud Native Computing Foundation (CNCF) as
+Dragonfly is now hosted by the Cloud Native Computing Foundation ([CNCF](https://cncf.io/)) as
 an Incubating Level Project. Originally it was born to
 solve all kinds of distribution at very large scales,
 such as application distribution, cache distribution,
 log distribution, image distribution, and so on.
+You can visit [d7y.io][d7y.io] for more information.
 
 ## Features
 
@@ -87,24 +88,24 @@ downloading files. It's similar to wget.
 
 ## Documentation
 
-You can find the full documentation [on the repo][document].
+You can find the full documentation on the [d7y.io][d7y.io].
 
 ## Community
 
 Welcome developers to actively participate in community discussions
 and contribute code to Dragonfly. We will remain
 concerned about the issues discussed in the community and respond quickly.
 
-- Slack Channel: [#dragonfly](https://cloud-native.slack.com/messages/dragonfly/) on [CNCF Slack](https://slack.cncf.io/)
-- Discussion Group: <[email protected]>
-- Developer Group: <[email protected]>
-- Github Discussions: [Dragonfly Discussion Forum][discussion]
-- Twitter: [@dragonfly_oss](https://twitter.com/dragonfly_oss)
-- DingTalk: `23304666`
+- **Slack Channel**: [#dragonfly](https://cloud-native.slack.com/messages/dragonfly/) on [CNCF Slack](https://slack.cncf.io/)
+- **Discussion Group**: <[email protected]>
+- **Developer Group**: <[email protected]>
+- **Github Discussions**: [Dragonfly Discussion Forum][discussion]
+- **Twitter**: [@dragonfly_oss](https://twitter.com/dragonfly_oss)
+- **DingTalk**: `23304666`
 
 <!-- markdownlint-disable -->
 <div align="center">
-  <img src="docs/en/images/community/dingtalk-group.jpeg" width="300" title="dingtalk">
+  <img src="docs/images/community/dingtalk-group.jpeg" width="300" title="dingtalk">
 </div>
 <!-- markdownlint-restore -->
 
@@ -117,11 +118,11 @@ You should check out our
 
 Please refer to our [Code of Conduct][codeconduct].
 
-[arch]: docs/en/images/arch.png
-[logo-linear]: docs/en/images/logo/dragonfly-linear.svg
+[arch]: docs/images/arch.png
+[logo-linear]: docs/images/logo/dragonfly-linear.svg
 [website]: https://d7y.io
 [discussion]: https://github.com/dragonflyoss/Dragonfly2/discussions
 [contributing]: CONTRIBUTING.md
 [codeconduct]: CODE_OF_CONDUCT.md
-[document]: docs/README.md
-[dingtalk]: docs/en/images/community/dingtalk-group.jpeg
+[d7y.io]: https://d7y.io/
+[dingtalk]: docs/images/community/dingtalk-group.jpeg

build/package/nfpm/dfget.yaml

@@ -23,7 +23,7 @@ contents:
     dst: /etc/dragonfly/dfget.yaml
     type: config
 
-  - src: /root/docs/en/cli-reference/dfget.1
+  - src: /root/docs/dfget.1
     dst: /usr/share/man/man1/dfget.1
 
   - src: /root/License

build/package/nfpm/docs/dfget.1

@@ -0,0 +1,137 @@
+.\" Automatically generated by Pandoc 2.13
+.\"
+.TH "DFGET" "1" "" "Version v2.0.1" "Frivolous \[lq]Dfget\[rq] Documentation"
+.hy
+.SH NAME
+.PP
+\f[B]dfget\f[R] \[em] client of Dragonfly used to download and upload
+files
+.SH SYNOPSIS
+.PP
+dfget is the client of Dragonfly which takes a role of peer in a P2P
+network.
+When user triggers a file downloading task, dfget will download the
+pieces of file from other peers.
+Meanwhile, it will act as an uploader to support other peers to download
+pieces from it if it owns them.
+In addition, dfget has the abilities to provide more advanced
+functionality, such as network bandwidth limit, transmission encryption
+and so on.
+.SS Options
+.TP
+\[en]alivetime
+alive duration for which uploader keeps no accessing by any uploading
+requests, after this period uploader will automatically exit (default
+5m0s)
+.TP
+\[en]cacerts
+the cacert file which is used to verify remote server when supernode
+interact with the source.
+.TP
+\[en]callsystem
+the name of dfget caller which is for debugging.
+Once set, it will be passed to all components around the request to make
+debugging easy
+.TP
+\[en]clientqueue
+specify the size of client queue which controls the number of pieces
+that can be processed simultaneously
+.TP
+\[en]console
+show log on console, it\[cq]s conflict with `\[en]showbar'
+.TP
+\[en]daemon-pid
+the daemon pid (default \[lq]/tmp/dfdaemon.pid\[rq])
+.TP
+\[en]daemon-sock
+the unix domain socket address for grpc with daemon (default
+\[lq]/tmp/dfdamon.sock\[rq])
+.TP
+\[en]dfdaemon
+identify whether the request is from dfdaemon
+.TP
+\[en]expiretime
+caching duration for which cached file keeps no accessed by any process,
+after this period cache file will be deleted (default 3m0s)
+.TP
+-f, \[en]filter
+filter some query params of URL, use char `&' to separate different
+params
+.TP
+\[en]header
+http header
+.TP
+-h, \[en]help
+help for dfget
+.TP
+\[en]home
+the work home directory of dfget (default
+\[lq]/Users/jim/.dragonfly/dfdaemon/\[rq])
+.TP
+-i, \[en]identifier
+the usage of identifier is making different downloading tasks generate
+different downloading task IDs even if they have the same URLs.
+conflict with \[en]md5.
+.TP
+\[en]insecure
+identify whether supernode should skip secure verify when interact with
+the source.
+.TP
+\[en]ip
+IP address that server will listen on (default \[lq]0.0.0.0\[rq])
+.TP
+-m, \[en]md5
+md5 value input from user for the requested downloading file to enhance
+security
+.TP
+\[en]more-daemon-options
+more options passed to daemon by command line, please confirm your
+options with \[lq]dfget daemon \[en]help\[rq]
+.TP
+-n, \[en]node
+deprecated, please use schedulers instead.
+specify the addresses(host:port=weight) of supernodes where the host is
+necessary, the port(default: 8002) and the weight(default:1) are
+optional.
+And the type of weight must be integer
+.TP
+\[en]notbacksource
+disable back source downloading for requested file when p2p fails to
+download it
+.TP
+-o, \[en]output
+destination path which is used to store the requested downloading file.
+It must contain detailed directory and specific filename, for example,
+`/tmp/file.mp4'
+.TP
+-p, \[en]pattern
+download pattern, must be p2p/cdn/source, cdn and source do not support
+flag \[en]totallimit (default \[lq]p2p\[rq])
+.TP
+\[en]port
+port number that server will listen on (default 65002)
+.TP
+\[en]schedulers
+the scheduler addresses
+.TP
+-b, \[en]showbar
+show progress bar, it is conflict with `\[en]console'
+.TP
+-e, \[en]timeout
+timeout set for file downloading task.
+If dfget has not finished downloading all pieces of file before
+\[en]timeout, the dfget will throw an error and exit
+.TP
+\[en]totallimit
+network bandwidth rate limit for the whole host, in format of
+G(B)/g/M(B)/m/K(B)/k/B, pure number will also be parsed as Byte (default
+104857600.000000)
+.TP
+-u, \[en]url
+URL of user requested downloading file(only HTTP/HTTPs supported)
+.TP
+\[en]verbose
+enable verbose mode, all debug log will be display
+.SH BUGS
+.PP
+See GitHub Issues: <https://github.com/dragonflyoss/Dragonfly2/issues>

build/package/nfpm/docs/dfget.1.md

@@ -0,0 +1,134 @@
+% DFGET(1) Version v2.0.1 | Frivolous "Dfget" Documentation
+
+# NAME
+
+**dfget** — client of Dragonfly used to download and upload files
+
+# SYNOPSIS
+
+dfget is the client of Dragonfly which takes a role of peer in a P2P network. When user triggers a file downloading
+task, dfget will download the pieces of file from other peers. Meanwhile, it will act as an uploader to support other
+peers to download pieces from it if it owns them. In addition, dfget has the abilities to provide more advanced
+functionality, such as network bandwidth limit, transmission encryption and so on.
+
+## Options
+
+--alivetime
+
+: alive duration for which uploader keeps no accessing by any uploading requests, after this period uploader will automatically exit (default 5m0s)
+
+--cacerts
+
+: the cacert file which is used to verify remote server when supernode interact with the source.
+
+--callsystem
+
+: the name of dfget caller which is for debugging. Once set, it will be passed to all components around the request to make debugging easy
+
+--clientqueue
+
+: specify the size of client queue which controls the number of pieces that can be processed simultaneously
+
+--console
+
+: show log on console, it's conflict with '--showbar'
+
+--daemon-pid
+
+: the daemon pid (default "/tmp/dfdaemon.pid")
+
+--daemon-sock
+
+: the unix domain socket address for grpc with daemon (default "/tmp/dfdamon.sock")
+
+--dfdaemon
+
+: identify whether the request is from dfdaemon
+
+--expiretime
+
+: caching duration for which cached file keeps no accessed by any process, after this period cache file will be deleted (default 3m0s)
+
+-f, --filter
+
+: filter some query params of URL, use char '&' to separate different params
+
+--header
+
+: http header
+
+-h, --help
+
+: help for dfget
+
+--home
+
+: the work home directory of dfget (default "/Users/jim/.dragonfly/dfdaemon/")
+
+-i, --identifier
+
+: the usage of identifier is making different downloading tasks generate different downloading task IDs even if they have the same URLs. conflict with --md5.
+
+--insecure
+
+: identify whether supernode should skip secure verify when interact with the source.
+
+--ip
+
+: IP address that server will listen on (default "0.0.0.0")
+
+-m, --md5
+
+: md5 value input from user for the requested downloading file to enhance security
+
+--more-daemon-options
+
+: more options passed to daemon by command line, please confirm your options with "dfget daemon --help"
+
+-n, --node
+
+: deprecated, please use schedulers instead. specify the addresses(host:port=weight) of supernodes where the host is necessary, the port(default: 8002) and the weight(default:1) are optional. And the type of weight must be integer
+
+--notbacksource
+
+: disable back source downloading for requested file when p2p fails to download it
+
+-o, --output
+
+: destination path which is used to store the requested downloading file. It must contain detailed directory and specific filename, for example, '/tmp/file.mp4'
+
+-p, --pattern
+
+: download pattern, must be p2p/cdn/source, cdn and source do not support flag --totallimit (default "p2p")
+
+--port
+
+: port number that server will listen on (default 65002)
+
+--schedulers
+
+: the scheduler addresses
+
+-b, --showbar
+
+: show progress bar, it is conflict with '--console'
+
+-e, --timeout
+
+: timeout set for file downloading task. If dfget has not finished downloading all pieces of file before --timeout, the dfget will throw an error and exit
+
+--totallimit
+
+: network bandwidth rate limit for the whole host, in format of G(B)/g/M(B)/m/K(B)/k/B, pure number will also be parsed as Byte (default 104857600.000000)
+
+-u, --url
+
+: URL of user requested downloading file(only HTTP/HTTPs supported)
+
+--verbose
+
+: enable verbose mode, all debug log will be display
+
+# BUGS
+
+See GitHub Issues: <https://github.com/dragonflyoss/Dragonfly2/issues>

docs/README.md

@@ -1,5 +1,5 @@
 # Dragonfly Document
 
-[English](en/README.md)
+You can find the full documentation on the [d7y.io](https://d7y.io).
 
-[简体中文](zh-CN/README.md)
+Welcome developers to contribute code to [d7y.io](https://d7y.io) and the source code repository is [dragonflyoss/d7y.io](https://github.com/dragonflyoss/d7y.io).