Design docs #5664
Design docs #5664
Conversation
Signed-off-by: Rob Hoes <rob.hoes@citrix.com>
Signed-off-by: Rob Hoes <rob.hoes@citrix.com>
Signed-off-by: Rob Hoes <rob.hoes@citrix.com>
| design_doc: true | ||
| revision: 2 | ||
| status: released (XenServer 6.5 SP1) | ||
| design_review: 12 |
There was a problem hiding this comment.
I see this field in the original page is a link to: http://github.com/xapi-project/xapi-project.github.io/issues/12, do we need to keep it?
And the same for other pages.
There was a problem hiding this comment.
Yes, I'll add those links, just for historical reasons.
doc/content/design/RDP.md
Outdated
| 1. If "Enable Remote Desktop console scanning" is on: | ||
| * The RDP button is present but greyed out. (It seems to sometimes read "Switch to Remote Desktop" and sometimes read "Looking for guest console...": I haven't yet worked out the difference). | ||
| * We scan the RDP port to detect when RDP is turned on | ||
| 2. If "Enable Remote Desktop console scanning" is off: | ||
| * The RDP button is enabled and reads "Switch to Remote Desktop" |
There was a problem hiding this comment.
I guess it does not render as expected?
And it is different from the rendering in the original page:
There was a problem hiding this comment.
Even the old one was bad! I've added a commit to fix it.
| menuTitle = "Designs" | ||
| +++ | ||
|
|
||
| {{< design_docs_list >}} |
There was a problem hiding this comment.
Sorry, will the design_docs_list be rendered as the list of docs under the folder? May I know how can the rendered page will accessed?
There was a problem hiding this comment.
Oh, I see it: doc/layouts/shortcodes/design_docs_list.html
There was a problem hiding this comment.
Yes, the {{< ... >}} bit refers to a "shortcode" in Hugo, which is something that can be included in a markdown doc and is automatically rendered as HTML.
| @@ -0,0 +1,40 @@ | |||
| {{ if eq $.Page.Params.design_doc true }} | |||
There was a problem hiding this comment.
May I know how these html pages will be rendered? Is it a page provided similar as homepage by github with Hugo, in that way, a page will be available under: https://xen-api.github.io/
There was a problem hiding this comment.
It's a table with metadata about the design like on the old pages:
E.g.:
Signed-off-by: Rob Hoes <rob.hoes@citrix.com>
Signed-off-by: Rob Hoes <rob.hoes@citrix.com>
Moving the final bits (well, nearly...) from xapi-project.github.io from Jekyll to Hugo.