Skip to content

Commit

Permalink
Minor edits.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ayardley
ayardley committed Nov 29, 2011
1 parent e721aaf commit 50068bb
Showing 1 changed file with 60 additions and 58 deletions.
118 changes: 60 additions & 58 deletions docs/TODO_revisions
View file
Expand Up @@ -5,94 +5,96 @@ revision of Parrot's Documentation Set. Please note, by complete, we
mean a set of documents sufficient to satisfy the goals set out in
'README_revisions.pod'.

[Open] 0. Solicit aid!
[Open] 0. Solicit aid!

[Done] 1. Write a README_revision and this TODO_revision and commit them
to a new documentation branch on github.
[Done] 1. Write a README_revision and this TODO_revision and commit them
to a new documentation branch on github.

[Done] 2. Create a new 'documentation_set' branch on github to house
our revisions.
[Done] 2. Create a new 'documentation_set' branch on github to house
our revisions.

[Open] 3. Convert 'docs.parrot.org' to Github pages.
[Done] 3. Convert 'docs.parrot.org' to Github pages.

[Open] 4. Review and revise (i.e., correct, update, and delete, where
appropriate) each and every document in the 'docs/' directory.
[Open] 4. Review and revise (i.e., correct, update, and delete, where
appropriate) each and every document in the 'docs/' directory.

[Open] 5. Add a new 'README.pod' to 'docs/', giving an overview of the
contents of each directory in 'docs/' and of the '*.pod's in
'docs/'.
[Open] 5. Add a new 'README.pod' to 'docs/', giving an overview of the
contents of each directory in 'docs/' and of the '*.pod's in
'docs/'.

[Open] 6. Apply a number system to all of the docs in 'docs/'
(e.g., something similar to what we presently use in
'docs/book/...').
[Open] 6. Apply a number system to all of the docs in 'docs/'
(e.g., something similar to what we presently use in
'docs/book/...').

[Open] 7. Revise and update 'docs/parrot.pod'.
[Open] 7. Revise and update 'docs/parrot.pod'.

[Open] 8. Add a directory structure for the new manuals.[1]
[Done] 8. Add a directory structure for the new manuals.[1]

[Open] 9. Revise the PIR book contained in 'docs/book/pir'.
[Open] 9. Revise the PIR book contained in 'docs/book/pir'.

[Open] 10. Revise the PCT book contained in 'docs/book/pct'.[2]
[Open] 10. Revise the PCT book contained in 'docs/book/pct'.[2]

[Open] 11. Revise 'parrotbug' to clarify its use for documents, as well
as its use for bugs (because we want folks to use 'parrotbug' to
inform us of any need doc changes or corrections).
[Open] 11. Revise 'parrotbug' to clarify its use for documents, as well
as its use for bugs (because we want folks to use 'parrotbug' to
inform us of any need doc changes or corrections).

[Open] 12. Revise 'README' to,
[Open] 12. Revise 'README' to,

(1) reflect this revision effort;
(1) reflect this revision effort;

(2) instruct folks to run 'make html' and use *only* the html
version of the docs, and *not* the pod docs in 'docs/';
(2) instruct folks to run 'make html' and use *only* the html
version of the docs, and *not* the pod docs in 'docs/';

(3) update 'FEEDBACK, PATCHES, etc.' section to make mention of
how to report or suggest doc changes/corrections/revisions; and
(3) update 'FEEDBACK, PATCHES, etc.' section to make mention of
how to report or suggest doc changes/corrections/revisions; and

(4) reformat the 'README' as a '*.pod'.
(4) reformat the 'README' as a '*.pod'.

[Open] 13. Revise 'docs/submissions.pod' to reflect this revision effort
(e.g., "How to submit bug reports, patches and new files to
Parrot" out now to read something like, "How to submit bug
reports, documentation changes, patches, and new files to Parrot")
[Open] 13. Revise 'docs/submissions.pod' to reflect this revision effort
(e.g., "How to submit bug reports, patches and new files to
Parrot" out now to read something like, "How to submit bug
reports, documentation changes, patches, and new files to Parrot")

[Open] 14. Ensure all 'README's are properly formatted in '*.pod'.
[Open] 14. Ensure all 'README's are properly formatted in '*.pod'.

[Open] 15. Identify and archive, where appropriate, any and all obsolete
documentation (e.g., Wikibooks, Allison Randall's video
presentations, etc.)
[Open] 15. Identify and archive, where appropriate, any and all obsolete
documentation (e.g., Wikibooks, Allison Randall's video
presentations, etc.)

[Open] 16. Update (or subclass or clone) 'perldoc' to,
[Open] 16. Update (or subclass or clone) 'perldoc' to,

(1) work more closely with Parrot's docs and
(1) work more closely with Parrot's docs and

(2) eliminate certain Perl specific features (e.g., displaying
the phrase, "User Contributed Perl Documentation", at the top
of the page.
(2) eliminate certain Perl specific features (e.g., displaying
the phrase, "User Contributed Perl Documentation", at the top
of the page.

[Open] 17. Write '*.pod' pages for each of the installable binaries in
Parrot's distribution.
[Open] 17. Write '*.pod' pages for each of the installable binaries in
Parrot's distribution.

[Open] 18. Write an autogen tool to run our '*.pod' pages in (17) above
through 'pod2man', converting them to '*roff' pages.
[Done] 17a. 'parrot.pod'

[Open] 19. Write an autogen indexer with which to generate an easy to use
reference to Parrot's documentation.
[Open] 18. Write an autogen tool to run our '*.pod' pages in (17) above
through 'pod2man', converting them to '*roff' pages.

[Open] 20. Implementation such tools, procedures, and tests as are necessary
to ensure Parrot's code documentation comports with its internal
coding standards.
[Open] 19. Write an autogen indexer with which to generate an easy to use
reference to Parrot's documentation.

[Open] 21. Create a new, friendlier front page for 'parrot.org'.
[Open] 20. Implementation such tools, procedures, and tests as are necessary
to ensure Parrot's code documentation comports with its internal
coding standards.

[Open] 22. Produce a "standard" presentation on the ParrotVM.
[Open] 21. Create a new, friendlier front page for 'parrot.org'.

[Open] 23. Develop something to help new users and developers keep track
of what they've read and where they've been in 'docs/'.[3]
[Open] 22. Produce a "standard" presentation on the ParrotVM.

[Open] 24. Implement some way to log completed revisions.[4]
[Open] 23. Develop something to help new users and developers keep track
of what they've read and where they've been in 'docs/'.[3]

[Open] 25. Implement an html link validation system to ensure the integrity
of our html links, especially to our, own documentation.
[Open] 24. Implement some way to log completed revisions.[4]

[Open] 25. Implement an html link validation system to ensure the integrity
of our html links, especially to our, own documentation.

Note: The above list is, by-no-means, complete. We will add tasks (and
subtasks to the above tasks) as this revision effort comes more clearly
Expand All @@ -112,4 +114,4 @@ up-to-date, corrections to the documents in 'docs/book/pct'.
it reads a DOT directory which contains the reader's document-flow.

[4] Write (or find) something on CPAN which will log our completions to
'.parrot_revision' directory within 'docs/'.
'.parrot_revision' directory within 'docs/'.

0 comments on commit 50068bb

Please sign in to comment.