ligato / docs Goto Github PK
View Code? Open in Web Editor NEW📚 Ligato documentation
Home Page: https://docs.ligato.io
📚 Ligato documentation
Home Page: https://docs.ligato.io
Ligato Docs currently contain 3 articles named KVScheduler
just in the navbar.
The last two seem to have started from same article, but now they are clearly very different due some modifications. We urgently need to clean this up to avoid confusing users.
This issue should also open some discussion about what kind of documenation should be kept at Plugins and Dev Guide.
At the moment the KVScheduler article from Dev Guide contains several different kinds of information:
I'm sure that this mix of information in single article just overwhelms the reader. Users are looking for specific type of information in the docs at one point in time.
To quote from the article What nobody tells you about documentation that I've shared before:
In fact, it’s extremely hard to maintain good documentation that doesn’t implicitly or explicitly recognise the quadrants of this scheme. The demands of each kind are different from those of the others, so any attempt at documentation that fails to maintain this structure suffers, as it’s pulled in different directions at once.
I think we should define and write down (I started some draft in wiki already) guidelines for writing docs and apply them to current docs.
per Ondrej:
Integration Tests is not properly named as this is info how to run robot tests and these are actually not being ran or maintained anymore, because we moved to Go tests for VPP integration and end-to-end tests
Suggestions on mod or moving content?
After some vpp-agent update of VPP we no longer use port 5002 for VPP CLI. Docs should be updated and omit -s localhost:5002
from vppctl
commands.
Originally posted by @ondrej-fabry in ligato/vpp-agent#1920 (comment)
Ligato is a framework just like say React is a framework. "Agent" term has multiple interpretations. Framework provides flexibility to add new plugins, drivers, apps, etc.
We have KV Data Store descriptions in concepts.md, related conf.file details in config-files.md and KV data store descriptions in db-plugins.md. This needs to be consolidated into one location.
My suggestion is move concepts.md KV data store descriptions to corresponding db-plugins.md sections. New db-plugins section will include pointer to corresponding config-file.md entry.
Results is one-stop shop for all things KV data store.
Replace 2017 VNF Agent with 2019 Ligato Framework diagram aligned with website version (can be great detail if appropriate)
remove or add TBD links to code at the bottom
replace old GRPC with new GRPC logo
Described in ligato/vpp-agent#1679
diagram at https://github.com/ligato/vpp-agent/blob/master/docs/kvscheduler/kvscheduler.md improves understanding
Hello, guys. Where are the definitions? I can't find them on the swaggerhub.
add agentctl examples to kvdb, rest and grpc
We should document or clarify supported VPP versions.
ligato/vpp-agent#1812 (WIP)
ligato/vpp-agent#1808 (closed)
Seem to recall another conversation
Section on Supported VPP versions is needed. Contents might be:
Please comment so I can add.
tx!
Problem below. Also how to tell if tutorial executed correctly or not.
$ go run main.go
main.go:21:2: cannot find package "github.com/ligato/cn-infra/agent" in any of:
/usr/local/go/src/github.com/ligato/cn-infra/agent (from $GOROOT)
/Users/chrismetz/go/src/github.com/ligato/cn-infra/agent (from $GOPATH)
main.go:22:2: cannot find package "github.com/ligato/cn-infra/infra" in any of:
/usr/local/go/src/github.com/ligato/cn-infra/infra (from $GOROOT)
/Users/chrismetz/go/src/github.com/ligato/cn-infra/infra (from $GOPATH)
main.go:23:2: cannot find package "github.com/ligato/cn-infra/logging" in any of:
/usr/local/go/src/github.com/ligato/cn-infra/logging (from $GOROOT)
/Users/chrismetz/go/src/github.com/ligato/cn-infra/logging (from $GOPATH)
main.go:24:2: cannot find package "github.com/ligato/vpp-agent/examples/tutorials/05_kv-scheduler/model" in any of:
/usr/local/go/src/github.com/ligato/vpp-agent/examples/tutorials/05_kv-scheduler/model (from $GOROOT)
/Users/chrismetz/go/src/github.com/ligato/vpp-agent/examples/tutorials/05_kv-scheduler/model (from $GOPATH)
main.go:25:2: cannot find package "github.com/ligato/vpp-agent/plugins/kvscheduler" in any of:
/usr/local/go/src/github.com/ligato/vpp-agent/plugins/kvscheduler (from $GOROOT)
/Users/chrismetz/go/src/github.com/ligato/vpp-agent/plugins/kvscheduler (from $GOPATH)
main.go:26:2: cannot find package "github.com/ligato/vpp-agent/plugins/kvscheduler/api" in any of:
/usr/local/go/src/github.com/ligato/vpp-agent/plugins/kvscheduler/api (from $GOROOT)
/Users/chrismetz/go/src/github.com/ligato/vpp-agent/plugins/kvscheduler/api (from $GOPATH)
based on ligato/vpp-agent#1734
Point to contivpp.io arch section and remove.
Notice both are used in different places. Need to use one. Generally speaking there is no "-" between network protocol and "agent" (e.g. openflow agent, netconf agent).
Okay in github, docs, website URLs but in human-readable text/figures/presos/blogs/etc, VPP agent (no dash version) is consistent with industry doc standards.
Will sync to determine where changes are needed
Include in OpenAPI defs.
root@node61:~# docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
66e63ec0adec ligato/vpp-agent "/bin/sh -c 'rm -f /…" About a minute ago Up About a minute 0.0.0.0:5002->5002/tcp, :::5002->5002/tcp, 0.0.0.0:9191->9191/tcp, :::9191->9191/tcp vpp-agent
e0d05238cdd2 quay.io/coreos/etcd "/usr/local/bin/etcd…" 19 minutes ago Up 19 minutes 0.0.0.0:2379->2379/tcp, :::2379->2379/tcp, 2380/tcp etcd
root@node61:~#
why can not connect 5002
root@node61:~# docker exec -it vpp-agent vppctl -s localhost:5002
connect: No such file or directory
root@node61:~#
Ligato Docs is missing info about our e2e tests. Executing them is very similar to Integration Tests (e.g. make e2e-tests
)
Testing code is located here: https://github.com/ligato/vpp-agent/tree/master/tests/e2e
described in ligato/vpp-agent#1670
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.