Comments (12)
Now we the prose in this project at https://github.com/flowbased/fbp-protocol/blob/master/spec/protocol.md and we generate docs from and autodeploy to: http://flowbased.github.io/fbp-protocol
So next step would be to migrate payload descriptions into the schemas, and generate the Markdown/HTML from that
from fbp-protocol.
Needed for flowbased/flowtrace#16
from fbp-protocol.
@jonnor, @ifitzpatrick and I can write a python script for this. I'm considering using jinja so that we can make a template .md file that loops over data pulled from the schema files. That will give us easy control over how the final doc is built.
from fbp-protocol.
Cool. Yep, generating an .md for the things coming from schema (or a set of
.md files) will be easy to integrate with other doc-building tools.
On 18 May 2016 at 22:55, Chad Dombrova [email protected] wrote:
@jonnor https://github.com/jonnor, @ifitzpatrick
https://github.com/ifitzpatrick and I can write a python script for
this. I'm considering using jinja http://jinja.pocoo.org/ so that we
can make a template .md file that loops over data pulled from the schema
files. That will give us easy control over how the final doc is built.—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#7 (comment)
Jon Nordby - www.jonnor.com
from fbp-protocol.
Related to #17
from fbp-protocol.
@jonnor #17 is pretty much ready to go. I think it just needs the flowtrace additions. Should we merge it in and then have you or @bergie update it with the flowtrace stuff?
from fbp-protocol.
@chadrik reviewed and found some problems with #17, see latest comments there. I think we can do the tracing subprotocol after we merge that, though can't really close this issue until it is all in.
from fbp-protocol.
Yep. Saw it and thanks for reviewing. Should be taken care of early next week.
from fbp-protocol.
To close this ticket I think we just need the flowtrace stuff. @jonnor is that feature targeted for version 0.6 of the protocol?
from fbp-protocol.
I think we should keep version bumps (like going to 0.6) to incompatible changes only.
The flowtrace stuff is only additions, and part of a new 'capability', and thus should not break any existing clients/runtimes. But I will move it into schemas so we can complete this.
from fbp-protocol.
Sure, makes sense.
from fbp-protocol.
flowtrace stuff now in schemas, https://github.com/flowbased/fbp-protocol/blob/master/schema/yaml/trace.yml
from fbp-protocol.
Related Issues (20)
- Add some styling to built documentation
- Identify requests and their responses HOT 4
- Improve schema files HOT 3
- tests: use schemas to validate messages HOT 1
- Allow port types to be specified using json-schema HOT 3
- `fbp-test` emits `graph/addedge` before `graph/addnode`. HOT 1
- Make npm version match the spec version HOT 1
- Support for embedded subgraphs HOT 6
- Ensure existing clients/runtime are in compliance with schemas
- Clarify the expected Graph Protocol messages from runtimes to clients HOT 1
- Feature Request: Add a graph:list command HOT 3
- Feature request: Add generic metadata field to components
- Runner doesn't work on Windows
- Duplicate entries in spec HTML HOT 2
- Add namespace and repository metadata to runtime information
- An in-range update of semver is breaking the build 🚨 HOT 2
- Runtime protocol: send list of supported component languages
- Version 10 of node.js has been released
- Move secret from payload
- Migrate schema to AsyncAPI
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from fbp-protocol.