You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@netbeans.apache.org by Eric Bresie <eb...@gmail.com> on 2021/03/04 19:59:41 UTC
Missing Wiki Pages - Java DevelopersGuide
I was looking at the Netbeans - Java Developers Guide page at
https://netbeans.apache.org/wiki/Java_DevelopersGuide.asciidoc
And from what I can tell, most of the links there point to non-existing sub
pages.
Are these just bad links that need to be corrected or did they get missed
when converting to asciidoc?
Looking in
https://github.com/apache/netbeans-website/tree/master/netbeans.apache.org/src/content/wiki
I see many documents but not all of them; the ascii doc pages seem to have
links to non-existent documents.
I see references to previous cleanup repository here
https://github.com/apache/netbeans-website-cleanup but not sure if all of
that is there either...
Some of the original content still seems to be present (for now - I
understand some of the original netbeans.org site is going away soon) on
the original site http://wiki.netbeans.org/JavaHT_Overview .
Thoughts?
Eric Bresie
ebresie@gmail.com
Re: Missing Wiki Pages - Java DevelopersGuide
Posted by Ernie Rael <er...@raelity.com>.
When I was exploring fixes for these files last July, in some direct
mail I received:
> not sure it's worth wasting time in upgrading hyperlinks in outdated
> tutorials. [...] the important thing about tutorials is what they
> teach, not whether they have proper links or not
I guess if I didn't jump around so much, I wouldn't be having trouble...
BTW, in my personal experience, in the few situations where I've
converted wiki to html, I had to do some sed to get links fixed up
automatically.
This netbeans wiki issue reminds me of a comment last month in the
thread about getting netbeans help to work:
> the real real question is who is going to keep that JavaHelp
> documentation updated?
I guess the consensus it that if it isn't up to date, it's not useful,
just let it be.
I'm not sure I agree with that. I suppose it's a legitimate position no
documentation is better than out of date documentation. But it seems the
longer it's left to rot, the less useful and more difficult things become.
And I'm not sure it's all that out of date. Considering that NB8.2 and
earlier docs are probably several dozens of man years work; has so much
changed that that they're mostly wrong/useless? Further, keeping docs
offline just makes it all that more difficult to keep/get docs updated.
As far as the conversion tools, I dug this up:
> exported it with "wiki-export" and then converted the stuff with
> "wiki-convert". Html pages were converted with "html-convert" and and
> improved version of that, for the platform tutorials, is
> "tutorials-convert".
>
> All these tools are at https://github.com/apache/netbeans-tools
>
> Code quality is so-so, as these were just helpers for the
> Oracle->Apache transition, expected to be run just once.
>
> We used different libraries from "org.eclipse.mylyn.docs" (see the
> pom.xml files), because these can parse different wiki formats (wiki
> export was in WikiText format, I think), AsciiDoc and HTML, so that
> eased conversion among different formats.
On 3/4/2021 3:44 PM, Eric Bresie wrote:
> Sounds like it.
>
> So how should this be handled?
>
> Do the documents need to be
> (1) Reconverted in some way
> (2) Change all the links in the pages (hopefully not manually)?
> (3) If present then but location or name changes then manually corrected?
> (4) Are the documents no longer relevant, OBE?
> (5) fix the "converter tool" and rerun on some previous collection of
> docs? What tool was used? One of these
> https://github.com/apache/netbeans-tools ?
>
>
> ebresie@gmail.com
>
>
> On Thu, Mar 4, 2021 at 4:58 PM Ernie Rael <er...@raelity.com> wrote:
>
>> On 3/4/2021 11:59 AM, Eric Bresie wrote:
>>> I was looking at the Netbeans - Java Developers Guide page at
>>>
>>> https://netbeans.apache.org/wiki/Java_DevelopersGuide.asciidoc
>>>
>>> And from what I can tell, most of the links there point to non-existing
>> sub
>>> pages.
>>>
>>> Are these just bad links that need to be corrected or did they get
>>> missed
>>> when converting to asciidoc?
>>>
>>> Looking in
>>>
>> https://github.com/apache/netbeans-website/tree/master/netbeans.apache.org/src/content/wiki
>>
>>> I see many documents but not all of them; the ascii doc pages seem to
>> have
>>> links to non-existent documents.
>>>
>>> I see references to previous cleanup repository here
>>> https://github.com/apache/netbeans-website-cleanup but not sure if all
>> of
>>> that is there either...
>>>
>>> Some of the original content still seems to be present (for now - I
>>> understand some of the original netbeans.org site is going away
>>> soon) on
>>> the original site http://wiki.netbeans.org/JavaHT_Overview .
>>>
>>> Thoughts?
>>>
>>> Eric Bresie
>>> ebresie@gmail.com
>>>
>> I ran into a variety of missing links with the wiki late last year;
>> discovered there were several thousands which are summarized in
>>
>> https://lists.apache.org/thread.html/re948d48587d1cdd631871a9cefe51f0e7f1465fc4baa51df1ef6245b%40%3Cdev.netbeans.apache.org%3E
>>
>>
>> These broken links were introduced by the conversion programs to
>> asciidoc. These are intra-file links, I don't know if this might be
>> related to what you're seeing.
>>
>> -ernie
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
>> For additional commands, e-mail: dev-help@netbeans.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.apache.org
For additional commands, e-mail: dev-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: Missing Wiki Pages - Java DevelopersGuide
Posted by Eric Bresie <eb...@gmail.com>.
Sounds like it.
So how should this be handled?
Do the documents need to be
(1) Reconverted in some way
(2) Change all the links in the pages (hopefully not manually)?
(3) If present then but location or name changes then manually corrected?
(4) Are the documents no longer relevant, OBE?
(5) fix the "converter tool" and rerun on some previous collection of
docs? What tool was used? One of these
https://github.com/apache/netbeans-tools ?
ebresie@gmail.com
On Thu, Mar 4, 2021 at 4:58 PM Ernie Rael <er...@raelity.com> wrote:
> On 3/4/2021 11:59 AM, Eric Bresie wrote:
> > I was looking at the Netbeans - Java Developers Guide page at
> >
> > https://netbeans.apache.org/wiki/Java_DevelopersGuide.asciidoc
> >
> > And from what I can tell, most of the links there point to non-existing
> sub
> > pages.
> >
> > Are these just bad links that need to be corrected or did they get missed
> > when converting to asciidoc?
> >
> > Looking in
> >
> https://github.com/apache/netbeans-website/tree/master/netbeans.apache.org/src/content/wiki
> >
> > I see many documents but not all of them; the ascii doc pages seem to
> have
> > links to non-existent documents.
> >
> > I see references to previous cleanup repository here
> > https://github.com/apache/netbeans-website-cleanup but not sure if all
> of
> > that is there either...
> >
> > Some of the original content still seems to be present (for now - I
> > understand some of the original netbeans.org site is going away soon) on
> > the original site http://wiki.netbeans.org/JavaHT_Overview .
> >
> > Thoughts?
> >
> > Eric Bresie
> > ebresie@gmail.com
> >
> I ran into a variety of missing links with the wiki late last year;
> discovered there were several thousands which are summarized in
>
> https://lists.apache.org/thread.html/re948d48587d1cdd631871a9cefe51f0e7f1465fc4baa51df1ef6245b%40%3Cdev.netbeans.apache.org%3E
>
> These broken links were introduced by the conversion programs to
> asciidoc. These are intra-file links, I don't know if this might be
> related to what you're seeing.
>
> -ernie
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
> For additional commands, e-mail: dev-help@netbeans.apache.org
>
> For further information about the NetBeans mailing lists, visit:
> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
>
>
>
>
Re: Missing Wiki Pages - Java DevelopersGuide
Posted by Ernie Rael <er...@raelity.com>.
On 3/4/2021 11:59 AM, Eric Bresie wrote:
> I was looking at the Netbeans - Java Developers Guide page at
>
> https://netbeans.apache.org/wiki/Java_DevelopersGuide.asciidoc
>
> And from what I can tell, most of the links there point to non-existing sub
> pages.
>
> Are these just bad links that need to be corrected or did they get missed
> when converting to asciidoc?
>
> Looking in
> https://github.com/apache/netbeans-website/tree/master/netbeans.apache.org/src/content/wiki
>
> I see many documents but not all of them; the ascii doc pages seem to have
> links to non-existent documents.
>
> I see references to previous cleanup repository here
> https://github.com/apache/netbeans-website-cleanup but not sure if all of
> that is there either...
>
> Some of the original content still seems to be present (for now - I
> understand some of the original netbeans.org site is going away soon) on
> the original site http://wiki.netbeans.org/JavaHT_Overview .
>
> Thoughts?
>
> Eric Bresie
> ebresie@gmail.com
>
I ran into a variety of missing links with the wiki late last year;
discovered there were several thousands which are summarized in
https://lists.apache.org/thread.html/re948d48587d1cdd631871a9cefe51f0e7f1465fc4baa51df1ef6245b%40%3Cdev.netbeans.apache.org%3E
These broken links were introduced by the conversion programs to
asciidoc. These are intra-file links, I don't know if this might be
related to what you're seeing.
-ernie
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
For additional commands, e-mail: dev-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists