[RTEMS Project] #3913: Review wiki references in rtems-docs for removal

[RTEMS trac]

#3913: Review wiki references in rtems-docs for removal
---------------------------+---------------------
 Reporter:  Joel Sherrill  |       Owner:  (none)
     Type:  enhancement    |      Status:  new
 Priority:  normal         |   Milestone:
Component:  doc            |     Version:
 Severity:  normal         |  Resolution:
 Keywords:  small, tasks   |  Blocked By:
 Blocking:                 |
---------------------------+---------------------
Description changed by Joel Sherrill:

Old description:

> This task asks you to check the [https://docs.rtems.org/ development
> manuals from https://docs.rtems.org/] for links to this wiki
> (devel.rtems.org) and to identify whether the linked content has been
> moved to the manuals, or whether it should be moved to the manuals. If it
> should be moved, determine how to move it and submit a patch to move the
> linked content. Once you identify the linked content is in the docs,
> update the link to reference to the location of the content in the docs.
>
> Long term, there is much content in the wiki that needs to find a new
> home in rtems-docs so it can be version controlled and packaged in sync
> with releases. Or it needs to be removed. The analysis of each wiki link
> may result in converting content to .rst and deleting the Wiki page,
> correcting links within the .rst documentation on previously converted
> documentation, or something else. Figure out what you think is the best
> place for the content given that we want as much as possible in rtems-
> docs for better version control and access. Make a recommendation, follow
> up with patches, lists of places to change references that you can't,
> etc.
>
> There are similar tasks to review and convert specific categories of wiki
> pages. This may cross over with that task but this list is from the
> rtems-docs perspective.
>
> To get the list:
>
> {{{
> cd ...../rtems-docs
> grep -r "http:.*wiki"
> }}}
>
> There are a few categories of this on first review:
>
> * Wiki pages converted to .rst content for the Software Engineering
> Guide. These are denoted by a comment with the Wiki URL in the text as a
> comment. Review the SW Eng version and verify it correctly represents the
> Wiki content. Fix any references to wiki pages remaining in the converted
> text and submit a patch. The end result of this should be to delete the
> original wiki page and identify where this page was referenced so those
> can be updated.
>
> * References to BSP wiki pages. Hopefully all the BSP wiki pages can be
> reviewed and either deleted as obsolete or of marginal value or converted
> to content in the Users Guide.
>
> * References to other Wiki pages. These may be correct or incorrect. The
> content of the Wiki page may need to be merged into somewhere in rtems-
> docs. The analysis will determine what the best thing to do is.

New description:

 This task asks you to check the [https://docs.rtems.org/ development
 manuals from https://docs.rtems.org/] for links to this wiki
 (devel.rtems.org) and to identify whether the linked content has been
 moved to the manuals, or whether it should be moved to the manuals. It it
 has been moved, the reference in the manual should be to where it is in
 the manual. If the wiki content should be moved, determine how to move it
 and submit a patch to move the linked content. Once you identify the
 linked content is in the docs, update the link to reference to the
 location of the content in the docs.

 Long term, there is much content in the wiki that needs to find a new home
 in rtems-docs so it can be version controlled and packaged in sync with
 releases. Or it needs to be removed. The analysis of each wiki link may
 result in converting content to .rst and deleting the Wiki page,
 correcting links within the .rst documentation on previously converted
 documentation, or something else. Figure out what you think is the best
 place for the content given that we want as much as possible in rtems-docs
 for better version control and access. Make a recommendation, follow up
 with patches, lists of places to change references that you can't, etc.

 There are similar tasks to review and convert specific categories of wiki
 pages. This may cross over with that task but this list is from the rtems-
 docs perspective.

 To get the list:

 {{{
 cd ...../rtems-docs
 grep -r "http:.*wiki"
 }}}

 There are a few categories of this on first review:

 * Wiki pages converted to .rst content for the Software Engineering Guide.
 These are denoted by a comment with the Wiki URL in the text as a comment.
 Review the SW Eng version and verify it correctly represents the Wiki
 content. Fix any references to wiki pages remaining in the converted text
 and submit a patch. The end result of this should be to delete the
 original wiki page and identify where this page was referenced so those
 can be updated.

 * References to BSP wiki pages. Hopefully all the BSP wiki pages can be
 reviewed and either deleted as obsolete or of marginal value or converted
 to content in the Users Guide.

 * References to other Wiki pages. These may be correct or incorrect. The
 content of the Wiki page may need to be merged into somewhere in rtems-
 docs. The analysis will determine what the best thing to do is.

--

--
Ticket URL: <http://devel.rtems.org/ticket/3913#comment:2>
RTEMS Project <http://www.rtems.org/>
RTEMS Project