-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[EngAut] generate prdoc ui PoC #244
Comments
I'm thinking that this could be a static GitHub-pages UI, and even a part of prdoc repo itself. https://forum.parity.io/t/pr-documentation-prdoc/2065/25?u=yuri_volkov |
Beware, in the first version, we had ONE schema. So |
And just when I was ready to test it, I found out that GitHub OAuth API doesn't support CORS: isaacs/github#330. UPD: @rzadp have suggested using "add file" links like this, which solves the problem |
@chevdor Hi! Here's an option how that could look: https://mutantcornholio.github.io/prdoc/?pull=16&org=paritytech&repo=prdoc&branch=wk-231019-completions I've pushed the source code here, however, this is a PoC, so it's not something that's remotely ready for merge.
|
Woo that looks like a neat option ! |
https://github.com/paritytech/prdoc/compare/yuri/prdoc-gen-poc?expand=1#diff-013e70c9bc6c6ea9370d573976ee48fd49cf49142968700bdb9b37a48d105c27 |
You have changes related to The audience as Are there resons why you removed:
|
Most of the reasons were cutting corners, to get PoC working. UPD: I kinda was able to do that and retain the description in the schema, using Code example "$defs": {
"audience": {
"description": "You may pick one or more audiences and address those users with appropriate documentation, information and warning related to the PR.",
"type": "string",
"options": [
{
"value": "Node Dev",
"label": "Node Dev",
"title": "Node Dev",
"description": "Those who build around the client side code. Alternative client builders, SMOLDOT, those who consume RPCs. These are people who are oblivious to the runtime changes. They only care about the meta-protocol, not the protocol itself."
},
{
"value": "Runtime Dev",
"label": "Runtime Dev",
"title": "Runtime Dev",
"description": "All of those who rely on the runtime. A parachain team that is using a pallet. A DApp that is using a pallet. These are people who care about the protocol (WASM), not the meta-protocol (client)."
},
{
"value": "Node Operator",
"label": "Node Operator",
"title": "Node Operator",
"description": "Those who don't write any code and only run code."
},
{
"value": "Runtime User",
"label": "Runtime User",
"title": "Runtime User",
"description": "Token holders who don't run anything but are involved in the network."
}
]
}, However, the problem is, the description is not displayed there. |
Related discussion: https://forum.parity.io/t/pr-documentation-prdoc/2065/21
In the future the prdocs will be a part of CI which will block PR unless either 1) the prdoc file for PR is provided 2) PR has the label
R0-silent
But for this to happen - we need to improve the devX by providing a simpler way to provide documentation for PR
The idea was - if the CI detected that prdoc was missing - send a link to some UI, which would provide an easier way to tell what was the change in PR and to whom this change relates. UI could enhance devX by providing the fields with an explanation and examples of how to document PR and what the audiences are etc
Obstacles: command-bot does not provide UI for now (tbd #128)
The text was updated successfully, but these errors were encountered: