update gnmi documentation on website#232
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
| <date month="January" year="2018" /> | ||
| </front> | ||
| </reference> | ||
| <reference anchor="GNMI-CONFIG-SUBS" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-config-subscriptions.md"> |
There was a problem hiding this comment.
This .xml source for the long expired draft should not be touched unless there is intention to bring this back through the IETF (which I believe is highly unlikely nor of interest at this point) - essentially these old references can stay untouched for historical reasons is all imo.
There was a problem hiding this comment.
Hej Ebben (@earies),
My main concern is that the documentation hosted on openconfig.net feels quite incomplete. While the Markdown files for gNMI extensions exist in the GitHub repository, they don’t seem to be used when rendering the website.
My assumption was that the XML document serves as an index of relevant files—similar to how mkdocs.yml works—and that it’s used in the CI flow to publish the site. But perhaps I missed something.
I’d be happy to help improve the publishing setup and ensure the docs are properly surfaced on the webpage. Pointing people directly to subfolders in the GitHub repo doesn’t feel like the right long-term solution.
/wiso
There was a problem hiding this comment.
Agreed - outside of the specification .md, I think doc reordering, a proper index and cleanup is necessary.... YMMV with the other docs atm.
This .xml is just the source to generate a draft for submission through the IETF so it's historical and not for the intentions you suggest. Worth keeping around but not to be edited.
target is to fix:
openconfig/gnmi#227