#1751: Links to DEPRECATED.pod et al
-------------------------------------+--------------------------------------
Reporter: Paul C. Anagnostopoulos | Owner: jkeenan
Type: todo | Status: assigned
Priority: normal | Milestone:
Component: docs | Version: 2.6.0
Severity: medium | Keywords:
Lang: | Patch:
Platform: |
-------------------------------------+--------------------------------------
Comment(by Paul C. Anagnostopoulos):
Sorry, I said wiki page but the Support Policy page is HTML:
http://docs.parrot.org/parrot/latest/html/docs/project/support_policy.pod.html.
Notice that it has three dead links to DEPRECATED.pod. Those need to be
fixed.
Now we also mention DECPRECATED.pod on the main wiki page:
http://trac.parrot.org/parrot/wiki. There is no link to it. Later on the
page we have a link to the ParrotDeprecations page, but not to the
ParrotDeprecationsForx.y pages.
I disagree that one file with all deprecations is overkill. It seems like
the minimalist approach to me. If they are in reverse order by version, a
person doesn't have to read any further than they care to. That file,
DEPRECATED.pod, is converted to HTML during the build, as you say. Then it
would be linked from both the Support Policy page and the main wiki page.
One source file, one target file, two links.
If you really think that one page per version, with a table of contents
page, is the way to go, I can be persuaded. The table of contents page
would be linked on the Support Policy and main wiki pages. Then we would
have a .pod file for the contents and one .pod file for each version,
right? But we would also have the information duplicated in
DEPRECATED.pod, which wouldn't even be linked anywhere. That's annoying.
Could we possibly organize DEPRECATED.pod with a table of contents at the
top and then a section for each version? Then a person could simply click
on the desired version and ignore the rest of the file.
'''Problem I am trying to solve''': It's not good to have deprecation
information in more than one source file. (When I was adding deprecation
information for a change, there was no way I was going to find all the
files I was supposed to edit without having it explained to me. And even
then I couldn't find ParrotDeprecationsFor2.6)
--
Ticket URL: <https://trac.parrot.org/parrot/ticket/1751#comment:8>
Parrot <https://trac.parrot.org/parrot/>
Parrot Development
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
