[
https://issues.apache.org/jira/browse/NETBEANS-1867?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16746572#comment-16746572
]
Antonio Vieiro commented on NETBEANS-1867:
------------------------------------------
Hi all,
Thanks for all this feedback!
* Of course we do want to improve the rendering/legibility of the tutorials.
The standard NOTE:, TIP: and the experimental kbd:[], and menu:[] are asciidoc
constructs that we want to improve using CSS. Keep sending suggestions and I'll
try my best.
* Regarding the table of contents scrolling with the page and highlighing the
current section that would be a nice thing to do, but with a low priority,
IMHO. I think it's more important to add a right aside that links to other
tutorials, or that adds more stuff (news, twitter entries, etc.) than just the
plain table of contents.
* Agreed that the banner height should be smaller. We may even have a very
small banner or no banner at all in the tutorials (would be easy to modify
src/content/templates/tutorial.gsp to achieve that). Also we can replace the
banner with links to different tutorial sections.
* Finally regarding generating custom HTML with jbake, I'd suggest avoiding
that as much as possible at the moment. That's a slippery slope we may want to
take later on, to avoid making things more complicated. Adding icons to NOTE:
and TIP:, for instance, can be done with some CSS hacks, I think, without
resorting to custom Java programming.
> [TUTORIALS] - review and publication
> ------------------------------------
>
> Key: NETBEANS-1867
> URL: https://issues.apache.org/jira/browse/NETBEANS-1867
> Project: NetBeans
> Issue Type: Task
> Components: website
> Reporter: Antonio Vieiro
> Priority: Major
> Labels: documentation, pull-request-available, third-donation,
> tutorials, website
> Attachments: image-2019-01-15-12-22-29-742.png,
> image-2019-01-15-12-26-14-652.png
>
> Time Spent: 50m
> Remaining Estimate: 0h
>
> The third donation from Oracle included the NetBeans Tutorials. These have
> been transformed automatically to the AsciiDoc format and need review.
> h2. Things to review
> Review process consists of the following steps:
> * Find the images that have not been donated, and create alternatives.
> * Fix any formatting issues from the automated process.
> * Review the "language" of the code examples, so syntax highlighing is
> correct.
> * Create learning trails.
> * Remove the "*Contents*" section of the tutorial pages (if any, the
> automatic process should have removed most of them), we should also remove
> the list of links to headings in the content in the Contents section. We're
> generating a Table of Contents automatically, so we don't need to manually
> create one.
> h2. Asigning a tutorial to yourself
> The review process will tackle different sets of Tutorials in the following
> order:
> # IDE Tutorials in src/content/kb/docs/ide
> # Java Tutorials in src/content/kb/docs/java
> # PHP Tutorials in src/content/kb/docs/php
> # Rest of tutorials: javaee, javame, web, webclient, websvc. Order will be
> defined later.
> If you want to review some tutorials please create a subtask using the
> *"More"/"Create sub-task"* menu entry, like so
> !image-2019-01-15-12-22-29-742.png|width=650,height=436!
> When creating the sub-task remember to set the "*labels*" field to
> *documentation / third-donation / tutorials / website,*
> like so:
> *!image-2019-01-15-12-26-14-652.png|width=741,height=126!*
> Also remember to *clearly state the tutorials you're working with* (say
> "java/a*": all tutorials starting with "a" in the "java" folder, or
> "ide/git.asciidoc").
> h2. Help Material / Tips & Tricks
> Please see
> [https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=100827339]
> for NetBeans specific Asciidoc Trips & Tricks.
> Please see
> [https://issues.apache.org/jira/secure/RapidBoard.jspa?projectKey=NETBEANS&rapidView=303]
> for a Kanban Board of the status the tutorials donation.
>
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
