This is an automated email from the ASF dual-hosted git repository.
geertjan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/netbeans-website.git
The following commit(s) were added to refs/heads/master by this push:
new 47e49b6 Minor editorial cleanups
new 1473ed2 Merge pull request #498 from bradh/patch-1
47e49b6 is described below
commit 47e49b6e758f0d4e326ab82c86c6ff7468afde05
Author: Brad Hards <[email protected]>
AuthorDate: Sun Nov 22 10:04:49 2020 +1100
Minor editorial cleanups
---
.../src/content/kb/docs/contributing.asciidoc | 31 +++++++++++-----------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
b/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
index 9c24b4f..a68b358 100644
--- a/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
+++ b/netbeans.apache.org/src/content/kb/docs/contributing.asciidoc
@@ -22,12 +22,11 @@
:jbake-type: tutorial
:jbake-tags: tutorials
:jbake-status: published
-:reviewed: 2019-01-25
+:reviewed: 2020-11-22
:toc: left
:icons: font
:toc-title:
:description: Tutorial Contribution Guidelines
-:reviewed: 2019-01-25
:experimental:
The Apache NetBeans Tutorials were included in the third donation from Oracle
to the Apache Software Foundation. Many of these tutorials need to be reviewed.
Everybody can help out in the review process. All you need is a web browser, a
GitHub account and a basic knowledge of link:https://asciidoc.org/[AsciiDoc].
@@ -56,7 +55,7 @@ image::images/contributing-link.png[title="Click the 'See
this page in GitHub' l
image::images/contributing-button.png[title="Edit button in GitHub"]
-If you don't have edit permissions you always can clone the
link:https://github.com/apache/netbeans-website[website repository in GitHub]
and then edit the file in your own clone, and then submit that as a Pull
Request against the main Apache Repository.
+If you don't have edit permissions you always can clone the
link:https://github.com/apache/netbeans-website[website repository in GitHub]
and edit the file in your own clone, and then submit that as a Pull Request
against the main Apache NetBeans website repository.
You can also watch the following YouTube video for instructions:
@@ -101,7 +100,7 @@ All tutorials must start with a "Level 0" title with a
single equal sign. This w
= This is a title
----
-It is an error if there's any content _before_ the level 0 title (but for
comments). If you see any content above the title then please move it below the
title (that's called the "AsciiDoc Preamble").
+It is an error if there is any content _before_ the level 0 title (but for
comments). If you see any content above the title then please move it below the
title (that's called the "AsciiDoc Preamble").
=== Metadata
@@ -130,11 +129,11 @@ This is a small description of the metadata:
- `jbake-type`: use `tutorial` for tutorial pages, `wiki` for wiki pages,
`page` for simple pages.
- `jbake-tags`: use `tutorials` for tutorials, feel free to any tags of your
liking (we should formalize this).
- `jbake-status`: always set it to `published`
-- Set `syntax` to `true` if this page contains source code that has to be
syntax-highlighted. Please also add `source-highlighter` to `pygments`.
+- Set `syntax` to `true` if this page contains source code that should be
syntax-highlighted. Please also add `source-highlighter` set to `pygments`.
- `toc` Set always to left.
- `toc-title` Leave empty.
- `icons` Set to `font` for adding support for FontAwesome icons.
-- `description`: set to something that describes the page. This is used for
SEO.
+- `description`: set to something that describes the page. This is used for
Search Engine Optimisation (SEO).
- `keywords`: keywords describing the page. This is used for SEO.
- `experimental`: enables button, menu paths, keyboard short cut graphics
@@ -142,7 +141,7 @@ This is a small description of the metadata:
Write the rest of the page using plain AsciiDoc. See the AsciiDoctor Writer's
Guide for more information https://asciidoctor.org/docs/asciidoc-writers-guide/
-You can structure the content using sections. Start each section with a level
1 header, that must have at least two equal signs (but can have more for
subsections), like so:
+You can structure the content using sections. Start each section with a level
1 header using two equal signs (subsections at level 2 and below just have more
equal signs), like so:
[source, asciidoc]
----
@@ -156,13 +155,15 @@ Some more stuff here
----
-TIP: In general we should make the tutorials be less wordy, less long
paragraphs. Special Constructs and Best Practices.
+TIP: In general we should make the tutorials be less wordy, less long
paragraphs.
+
+== Special Constructs and Best Practices.
=== Inline screenshots and images
Images related to a webpage are usually included in a `images/` subdirectory
close to the webpage.
-Screenshots should be at least 640px wide?? (what's a good size for retina
images?). PNG is preferred (isn't it?)
+Screenshots should be at least 640px wide?? (what's a good size for retina
images?). PNG is preferred.
Images in a table should be inlined, i.e., using the `single colon` image
construct, like so:
@@ -216,7 +217,7 @@ where "the-youtube-video-identifier" is the id of the
youtube video, for instanc
=== Source code
-Use the plain asciidoc construct for source code excerpts (that is, four
slashes). Please the the "lang" attribute accordingly, for instance, for Java:
+Use the plain asciidoc construct for source code excerpts (that is, four
slashes). Please set the "lang" attribute accordingly, for instance, for Java:
[source, asciidoc]
----
@@ -226,7 +227,7 @@ Use the plain asciidoc construct for source code excerpts
(that is, four slashes
----
----
-Other languages are `html`, `xml`, `javascript`, `php`, `python`, `ruby`.
Remember to use the `:syntax: true` atribute in the metadata so that syntax
highlighting works.
+Other languages are `html`, `xml`, `javascript`, `php`, `python`, `ruby`.
Remember to use the `:syntax: true` attribute in the metadata so that syntax
highlighting works.
=== Numbered lists
@@ -251,7 +252,7 @@ Now we have a paragraph here, or an image or whatever
=== Admonitions (notes, tips)
-Use `NOTE:` and `TIP:` for admonitions. These must be in capital letters,
without any asterkisks around them:
+Use `NOTE:` and `TIP:` for admonitions. These must be in capital letters,
without any asterisks around them:
[source, asciidoc]
----
@@ -283,7 +284,7 @@ for a list of icons see
https://fontawesome.com/icons?d=gallery
=== Keyboard shortcuts
Keyboard short cuts can be displayed in a graphical way using the *kbd:[]*
macro. +
-To enable the use of keyboard shortcut graphics, include the `:experimental:`
in the metadata of the page.
+To enable the use of keyboard shortcut graphics, include `:experimental:` in
the metadata of the page.
[source, asciidoc]
----
@@ -298,7 +299,7 @@ kbd:[Ctrl+Shift+N] - Create a *New Project*
_Produces this result_ +
kbd:[Ctrl+Shift+N] - Create a *New Project*
-There is a trick to using things like a backslash. A backslash must be
followed by a proceeding space.
+There is a trick to using things like a backslash. A backslash must be
followed by a preceding space.
_Notice the space between the backslash and the closing bracket_ +
----
@@ -312,5 +313,5 @@ kbd:[Ctrl+\ ]
=== New features
If you need to include a new feature in the page then
-please request for it in our
link:http://netbeans.apache.org/community/mailing-lists.html[Dev Mailing List].
+please request it using our
link:http://netbeans.apache.org/community/mailing-lists.html[Dev Mailing List].
---------------------------------------------------------------------
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
