You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@netbeans.apache.org by Jeremy Cavanagh <je...@orange.fr> on 2019/02/19 12:29:53 UTC
Changes to revised documentation
Hi Everyone,
I didn't like the appearance of my first submission, and have revised
formatting.
Do I need to create a new pull request or will my changes happen
automatically?
Sorry to ask these questions but, trying to get up to speed with lots of
things (contributing to a GitHub project, learning Asciidoc etc.) I need
really, really simple info with examples. These things are not easy to
find on the web.
Finally, how are the live pages created? Is it possible to run apps on
my Mac so that I can test before making submissions. I am currently
doing changes on Atom with all the Asciidoc plugins I can find but,
although the appearance in preview seems reasonable it is not the same
as the 'live' version.
Any help would be gratefully accepted as I don't want to make any more
submissions until I am sure that what I do will look okay on the
NetBeans website.
Kindest regards
Jeremy
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@netbeans.incubator.apache.org
For additional commands, e-mail: dev-help@netbeans.incubator.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: Changes to revised documentation
Posted by Geertjan Wielenga <ge...@googlemail.com.INVALID>.
Please do ask all your questions, don't hesitate! :-)
Sure, do a new pull request, that makes sense.
I'm also working on a screencast that will show how I do documentation
reviews (I literally clone the website repo, open a tutorial page in my
GitHub repo, make my changes, and then create a new branch in GitHub and
then do the push from there). I.e., I do everything on-line -- but then I'm
not making very large changes, for those your approach makes sense.
And don't worry too much about it all being 100% correct, just do the push
and no worries at all with problems, we'll review and merge and then take
it from there. The perfect is the enemy of the good enough, etc.
Gj
On Tue, Feb 19, 2019 at 1:45 PM Jeremy Cavanagh <je...@orange.fr>
wrote:
> Hi Everyone,
>
> I didn't like the appearance of my first submission, and have revised
> formatting.
>
> Do I need to create a new pull request or will my changes happen
> automatically?
>
> Sorry to ask these questions but, trying to get up to speed with lots of
> things (contributing to a GitHub project, learning Asciidoc etc.) I need
> really, really simple info with examples. These things are not easy to
> find on the web.
>
> Finally, how are the live pages created? Is it possible to run apps on
> my Mac so that I can test before making submissions. I am currently
> doing changes on Atom with all the Asciidoc plugins I can find but,
> although the appearance in preview seems reasonable it is not the same
> as the 'live' version.
>
> Any help would be gratefully accepted as I don't want to make any more
> submissions until I am sure that what I do will look okay on the
> NetBeans website.
>
> Kindest regards
>
> Jeremy
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@netbeans.incubator.apache.org
> For additional commands, e-mail: dev-help@netbeans.incubator.apache.org
>
> For further information about the NetBeans mailing lists, visit:
> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
>
>
>
>
Re: Changes to revised documentation
Posted by Antonio <an...@vieiro.net>.
Hi Jeremy,
El 19/02/2019 a las 13:29, Jeremy Cavanagh escribió:
> Hi Everyone,
>
> I didn't like the appearance of my first submission, and have revised
> formatting.
Thanks for your submission and for your revision.
>
> Do I need to create a new pull request or will my changes happen
> automatically?
Since your pull request was already merged then yes, you need to create
a new pull request (i.e., a new branch and then a pull request).
>
> Sorry to ask these questions but, trying to get up to speed with lots of
Don't be afraid to ask questions. We're afraid of people that don't ask
questions! :-)
> things (contributing to a GitHub project, learning Asciidoc etc.) I need
> really, really simple info with examples. These things are not easy to
> find on the web.
>
Agreed. All that stuff is complicated. That's the reason why we're glad
you ask us.
> Finally, how are the live pages created? Is it possible to run apps on
The NetBeans website is built with a gradle project.
Just clone your fork of the incubator-netbeans-website in a directory of
your liking:
cd my-repositories (or whatever)
git clone git@github.com:JeremyCavanagh/incubator-netbeans-website.git
(if you have a ssh key, or)
git clone https://github.com/JeremyCavanagh/incubator-netbeans-website.git
(if you don't)
then:
cd "incubator-netbeans-website" (this is where git cloned the repo)
cd "netbeans.apache.org" (this is a directory inside the repo)
./gradlew clean buildSite run
(the "clean" is only required if you've built the site before and made
important changes)
This will generate lots of output, download half internet, show some
warnings, and then you can browse http://localhost:8080 and you should
see your local website.
> my Mac so that I can test before making submissions. I am currently
Testing before making submissions is appreciated.
> doing changes on Atom with all the Asciidoc plugins I can find but,
> although the appearance in preview seems reasonable it is not the same
> as the 'live' version.
Exactly. The gradle project above adds some css/images/etc. to the
generated HTML automatically.
It's ok if you use any other editor. The visualization of the asciidoc
documents won't be the same, but the important thing is the content, not
the way it looks. Just build the site once before submitting.
If you see something very bad in the generated website (fonts, colors,
layout, etc.) then just let us know. We're improving the site continuosly.
>
> Any help would be gratefully accepted as I don't want to make any more
> submissions until I am sure that what I do will look okay on the
> NetBeans website.
>
Thanks for that.
Some help: Don't add newlines between the first level and the document
metadata. So, for instance, this is wrong:
= The title
:foo: bar
But this is right:
= The title
:foo: bar
> Kindest regards
>
> Jeremy
>
Thanks for helping!
Un abrazo,
Antonio
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@netbeans.incubator.apache.org
> For additional commands, e-mail: dev-help@netbeans.incubator.apache.org
>
> For further information about the NetBeans mailing lists, visit:
> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@netbeans.incubator.apache.org
For additional commands, e-mail: dev-help@netbeans.incubator.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: Changes to revised documentation
Posted by Antonio <an...@vieiro.net>.
Hi Jeremy,
Sorry for the late reply.
El 20/02/2019 a las 14:41, jeremy.cavanagh@orange.fr escribió:
>
> [...]
> Now down to the difficult bit, I am trying to follow Antonio's very clear guide to install a local test suite. But, it fails:
>
> MBP-High-Sierra:netbeans.apache.org jeremycavanagh$ ./gradlew clean buildSite run --stacktrace
> :buildSrc:compileJava NO-SOURCE
> :buildSrc:compileGroovy UP-TO-DATE
It seems gradle is running properly.
On the command line, please run
java -version
to know the java version you're using, and
git status
to know which git branch you're using. And let us know what those
commands say.
> [...]
> :buildSrc:classes UP-TO-DATE
>
> FAILURE: Build failed with an exception.
>
>
> Here is a summary of the stacktrace:
>
>
> * What went wrong:
> Execution failed for task ':bake'.
>> java.lang.ExceptionInInitializerError (no error message)
> ..
> * Exception is:
> org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':bake'.
> ..
> Caused by: java.lang.ExceptionInInitializerError
> ..
> Caused by: java.lang.IllegalArgumentException: Invalid key
This is weird. Can't tell what this means. Have you modified any
asciidoc file? Maybe you have a wrong key in the document metadata.
For instance:
= Title
:wrong key here: value
Remember that keys should not have spaces (just dashes).
>
> Have I done something wrong?
>
Don't think so.
Cheers,
Antonio
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@netbeans.incubator.apache.org
For additional commands, e-mail: dev-help@netbeans.incubator.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: Changes to revised documentation
Posted by je...@orange.fr,
je...@orange.fr.
On 2019/02/19 12:29:53, Jeremy Cavanagh <je...@orange.fr> wrote:
> Hi Everyone,
>
> I didn't like the appearance of my first submission, and have revised
> formatting.
>
> Do I need to create a new pull request or will my changes happen
> automatically?
>
> Sorry to ask these questions but, trying to get up to speed with lots of
> things (contributing to a GitHub project, learning Asciidoc etc.) I need
> really, really simple info with examples. These things are not easy to
> find on the web.
>
> Finally, how are the live pages created? Is it possible to run apps on
> my Mac so that I can test before making submissions. I am currently
> doing changes on Atom with all the Asciidoc plugins I can find but,
> although the appearance in preview seems reasonable it is not the same
> as the 'live' version.
>
> Any help would be gratefully accepted as I don't want to make any more
> submissions until I am sure that what I do will look okay on the
> NetBeans website.
>
> Kindest regards
>
> Jeremy
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@netbeans.incubator.apache.org
> For additional commands, e-mail: dev-help@netbeans.incubator.apache.org
>
> For further information about the NetBeans mailing lists, visit:
> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
>
>
>
> Thank you both for your kind and helpful comments, it's very encouraging to receive such a warm welcome.
Now down to the difficult bit, I am trying to follow Antonio's very clear guide to install a local test suite. But, it fails:
MBP-High-Sierra:netbeans.apache.org jeremycavanagh$ ./gradlew clean buildSite run --stacktrace
:buildSrc:compileJava NO-SOURCE
:buildSrc:compileGroovy UP-TO-DATE
:buildSrc:processResources NO-SOURCE
:buildSrc:classes UP-TO-DATE
:buildSrc:jar UP-TO-DATE
:buildSrc:assemble UP-TO-DATE
:buildSrc:compileTestJava NO-SOURCE
:buildSrc:compileTestGroovy NO-SOURCE
:buildSrc:processTestResources NO-SOURCE
:buildSrc:testClasses UP-TO-DATE
:buildSrc:test NO-SOURCE
:buildSrc:check UP-TO-DATE
:buildSrc:build UP-TO-DATE
:clean
:compileContentSass
$offcanvas-size is deprecated and not used anymore! Please update your settings and use the map $offcanvas-sizes instead
$offcanvas-vertical-size is deprecated and not used anymore! Please update your settings and use the map $offcanvas-vertical-sizes instead
:preprocessContentAssets
:preprocessContentStatics
:preprocessContentTemplates NO-SOURCE
:preprocessTemplates
:preprocessContent
:bake FAILED
FAILURE: Build failed with an exception.
Here is a summary of the stacktrace:
* What went wrong:
Execution failed for task ':bake'.
> java.lang.ExceptionInInitializerError (no error message)
..
* Exception is:
org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':bake'.
..
Caused by: java.lang.ExceptionInInitializerError
..
Caused by: java.lang.IllegalArgumentException: Invalid key
Have I done something wrong?
Sorry for not using an email reply with attachments, but, I'm re-organising my workspace to make it much easier for me to work on the documentation.
Regards
Jeremy
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@netbeans.incubator.apache.org
For additional commands, e-mail: dev-help@netbeans.incubator.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists