You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@netbeans.apache.org by "Eric Barboni (Jira)" <ji...@apache.org> on 2020/03/09 12:45:00 UTC
[jira] [Updated] (NETBEANSINFRA-154) [TUTORIALS] - review and
publication
[ https://issues.apache.org/jira/browse/NETBEANSINFRA-154?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eric Barboni updated NETBEANSINFRA-154:
---------------------------------------
Description:
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?rapidView=367&projectKey=NETBEANSINFRA] for a Kanban Board of the status the tutorials donation.
was:
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.
> [TUTORIALS] - review and publication
> ------------------------------------
>
> Key: NETBEANSINFRA-154
> URL: https://issues.apache.org/jira/browse/NETBEANSINFRA-154
> Project: Apache NetBeans Infra
> Issue Type: Task
> Components: Website - Editorial
> 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: 7h 20m
> 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?rapidView=367&projectKey=NETBEANSINFRA] for a Kanban Board of the status the tutorials donation.
>
>
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@netbeans.apache.org
For additional commands, e-mail: commits-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists