Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Commit 277e641

Browse files
committed
api: reference externally hosted docs
The ones _we_ build are crappier and are painful to get building properly. We might as well link to other documentation sources. * These new sources will _always_ be up to date. * The new go documentation will: * Properly hyperlink * Not require one sidebar link per package. We currently have links in the sidebar for subpackages that really don't belong as top-level links.
1 parent 2df9717 commit 277e641

File tree

7 files changed

+55
-146
lines changed

7 files changed

+55
-146
lines changed

Makefile

+2-13
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,7 @@ ipfs-theme:
3030
$(PREPEND)cp ./node_modules/ipfs-css/fonts/Inter-UI* ./build/assets/fonts/ $(APPEND)
3131
$(PREPEND)node scripts/ipfs-css-constants.js $(APPEND)
3232

33-
packages:
34-
# The JS packages don't actually generate useful docs right now, so skip them
35-
# $(PREPEND)scripts/pkg2md.sh github.com/ipfs/js-ipfs-http-client master $(PKGDIR) pkg
36-
# $(PREPEND)scripts/pkg2md.sh github.com/ipfs/js-ipfs master $(PKGDIR) pkg
37-
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/go-ipfs-api v0.0.2 $(PKGDIR) go/pkg
38-
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/go-ipfs-http-client v0.0.3 $(PKGDIR) go/pkg
39-
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core v0.1.0 $(PKGDIR) go/pkg
40-
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core/options v0.1.0 $(PKGDIR) go/pkg
41-
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core/path v0.1.0 $(PKGDIR) go/pkg
42-
$(PREPEND)scripts/pkg2md.sh github.com/ipfs/interface-go-ipfs-core/options/namesys v0.1.0 $(PKGDIR) go/pkg
43-
44-
resources: ipfs-theme packages
33+
resources: ipfs-theme
4534

4635
install: node_modules resources
4736

@@ -86,4 +75,4 @@ clean:
8675
$(PREPEND)[ ! -d $(PKGDIR) ] || rm -rf $(PKGDIR)/*/
8776
$(PREPEND)[ ! -d build/assets ] || rm -rf build/assets/*
8877

89-
.PHONY: packages build help deploy publish-to-domain clean
78+
.PHONY: build help deploy publish-to-domain clean

config.toml

+13-12
Original file line numberDiff line numberDiff line change
@@ -95,25 +95,26 @@ identifier = "go_implementation"
9595
name = "Go Implementation"
9696
weight = 5
9797
[[menu.reference]]
98+
identifier = "go_coreapi"
9899
parent = "go_implementation"
99-
name = "go-ipfs Core API"
100-
url = "/go/pkg/go-ipfs/core/coreapi"
101-
weight = 10
102-
[[menu.reference]]
103-
parent = "go_implementation"
104-
name = "go-ipfs Coreiface API"
105-
url = "/go/pkg/go-ipfs/core/coreapi/interface"
100+
name = "Go Core API"
101+
url = "https://godoc.org/github.com/ipfs/interface-go-ipfs-core"
106102
weight = 11
107103
[[menu.reference]]
108104
parent = "go_implementation"
109-
name = "go-ipfs Core options API"
110-
url = "/go/pkg/go-ipfs/core/coreapi/interface/options"
105+
name = "Go HTTP Client (experimental)"
106+
url = "https://godoc.org/github.com/ipfs/go-ipfs-http-client"
111107
weight = 12
112108
[[menu.reference]]
113109
parent = "go_implementation"
114-
name = "go-ipfs-api Reference"
115-
url = "/go/pkg/go-ipfs-api"
116-
weight = 30
110+
name = "Go Embedded Client (experimental)"
111+
url = "https://godoc.org/github.com/ipfs/go-ipfs/core/coreapi"
112+
weight = 13
113+
[[menu.reference]]
114+
parent = "go_implementation"
115+
name = "Go HTTP Client (old but stable)"
116+
url = "https://godoc.org/github.com/ipfs/interface-go-ipfs-core"
117+
weight = 15
117118

118119
[[menu.reference]]
119120
identifier = "js_implementation"

content/reference/api/cli.md

+38-18
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ menu:
1414

1515
This document is autogenerated from <a href='https://github.com/ipfs/docs/blob/master/scripts/cli.sh'>scripts/cli.sh</a>. For issues and support, check out the <a href='https://github.com/ipfs/docs'>docs repository</a> on GitHub.
1616

17-
*Generated on 2019-07-16 15:20:49, from go-ipfs 0.4.21.*
17+
*Generated on 2019-08-30 18:40:23, from go-ipfs 0.4.22.*
1818

1919
- [ipfs](#ipfs)
2020
- [ipfs add](#ipfs-add)
@@ -541,10 +541,10 @@ OPTIONS
541541
DESCRIPTION
542542
543543
'ipfs block put' is a plumbing command for storing raw IPFS blocks.
544-
It reads from stdin, and <key> is a base58 encoded multihash.
544+
It reads from stdin, and outputs the block's CID to stdout.
545545
546-
By default CIDv0 is going to be generated. Setting 'mhtype' to anything other
547-
than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
546+
Unless specified, this command returns dag-pb CIDv0 CIDs. Setting 'mhtype' to anything
547+
other than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
548548
549549
550550
```
@@ -1010,6 +1010,17 @@ SYNOPSIS
10101010
DESCRIPTION
10111011
10121012
Available profiles:
1013+
'randomports':
1014+
Use a random port number for swarm.
1015+
'server':
1016+
Disables local host discovery, recommended when
1017+
running IPFS on machines with public IPv4 addresses.
1018+
'local-discovery':
1019+
Sets default values to fields affected by the server
1020+
profile, enables discovery in local networks.
1021+
'test':
1022+
Reduces external interference of IPFS daemon, this
1023+
is useful when using the daemon in test environments.
10131024
'default-networking':
10141025
Restores default network settings.
10151026
Inverse profile of the test profile.
@@ -1045,17 +1056,6 @@ DESCRIPTION
10451056
functionality - performance of content discovery and data
10461057
fetching may be degraded.
10471058
1048-
'randomports':
1049-
Use a random port number for swarm.
1050-
'server':
1051-
Disables local host discovery, recommended when
1052-
running IPFS on machines with public IPv4 addresses.
1053-
'local-discovery':
1054-
Sets default values to fields affected by the server
1055-
profile, enables discovery in local networks.
1056-
'test':
1057-
Reduces external interference of IPFS daemon, this
1058-
is useful when using the daemon in test environments.
10591059
10601060
SUBCOMMANDS
10611061
ipfs config profile apply <profile> - Apply profile to config.
@@ -4517,9 +4517,29 @@ DESCRIPTION
45174517
## ipfs update
45184518

45194519
```
4520-
ipfs-update is an 'external' command.
4521-
It does not currently appear to be installed.
4522-
Please refer to the ipfs documentation for instructions.
4520+
NAME:
4521+
ipfs-update - Update ipfs.
4522+
4523+
USAGE:
4524+
ipfs-update [global options] command [command options] [arguments...]
4525+
4526+
VERSION:
4527+
1.5.3-dev
4528+
4529+
COMMANDS:
4530+
versions Print out all available versions.
4531+
version Print out currently installed version.
4532+
install Install a version of ipfs.
4533+
stash stashes copy of currently installed ipfs binary
4534+
revert Revert to previously installed version of ipfs.
4535+
fetch Fetch a given version of ipfs. Default: latest.
4536+
help, h Shows a list of commands or help for one command
4537+
4538+
GLOBAL OPTIONS:
4539+
--verbose Print verbose output.
4540+
--distpath value specify the distributions build to use
4541+
--help, -h show help
4542+
--version, -v print the version
45234543
```
45244544

45254545
## ipfs urlstore

content/reference/go/overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ For more technical information about building, debugging or using the API, see:
2828

2929
If you plan to use `go-ipfs` as a package in your own Go application, you can take any of three main approaches:
3030

31-
- Use **[`go-ipfs`](https://github.com/ipfs/go-ipfs)** to run IPFS directly in your own process. See [the API reference](/go/pkg/go-ipfs/core/coreapi).
32-
- Use **[`go-ipfs-api`](https://github.com/ipfs/go-ipfs-api)** to communicate with an IPFS daemon in a separate process via its HTTP API (this is what `go-ipfs` does if a daemon is already running). See [the API reference](/go/pkg/go-ipfs-api).
31+
- Use **[`go-ipfs`](https://github.com/ipfs/go-ipfs)** to run IPFS directly in your own process. See the [CoreAPI constructor](/go/pkg/go-ipfs/core/coreapi).
32+
- Use **[`go-ipfs-htp-client`](https://github.com/ipfs/go-ipfs-http-client)** to communicate with an IPFS daemon in a separate process via its HTTP API (this is what `go-ipfs` does if a daemon is already running). See the [http client](/go/pkg/go-ipfs-http-client).
3333
- Use other Go packages to communicate with the HTTP API directly. See the [HTTP API reference](/api/http).

go.mod

-5
This file was deleted.

go.sum

-4
This file was deleted.

scripts/pkg2md.sh

-92
This file was deleted.

0 commit comments

Comments
 (0)