search

textileio / go-textile

[DEPRECATED] Textile is a set of tools and infrastructure for building composable apps and services on the IPFS network
https://textile.io
MIT License
357 stars 43 forks source link

meta: docs should be generated by CI, not by us #810

Closed balupton closed 5 years ago

balupton commented 5 years ago

Ref https://github.com/textileio/meta/issues/6

Changes:

Signed-off-by: Benjamin Lupton b@lupton.cc

balupton commented 5 years ago

Review of this will need to let me know what things docs affect, and where in the CI pipeline this is handled.

There is also another part of this PR, which will be to amend the git history to truncate the docs folder so our repo size is shrunk down. However, that will break all unpushed changes. So not sure when we can schedule that.

carsonfarmer commented 5 years ago

docs.go needs to be available at build time, as do the various swagger files. These are also needed at run time to serve the local docs. So they probably do need to be in VC? Otherwise, we'd need to re-build them each time? (these aren't just external docs, these are served via textile daemon --serve-docs

balupton commented 5 years ago

Ok cool.

Rebuilding each time, or at least during publishing, makes sense, as otherwise they risk getting out of date - which is already the current situation

carsonfarmer commented 5 years ago

They are an actual go 'package' imported into core/api.go. So I guess they'd have to be built each time? That doesn't seem ideal?

Could be added as a step to make build? But I think go might have issues with that when go geting go-textile, we'll have to test.

balupton commented 5 years ago

Could be added as a step to make build? But I think go might have issues with that when go geting go-textile, we'll have to test.

good point, more research is needed