[
https://issues.apache.org/jira/browse/NETBEANS-1867?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16748703#comment-16748703
]
Geertjan Wielenga commented on NETBEANS-1867:
---------------------------------------------
I think it would be really helpful to have two states for a tutorial: "ready to
be used" and "under review", with an icon for each, that we could put on each
tutorial as an indicator and to set expectations. Could you create such an
enhancement, assuming you agree with it?
It would not be release-specific, i.e., it would not be "tested for Apache
NetBeans 10" or something, it would be a general comment of go/no go per
tutorial.
> [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
