Opened 11 months ago

Closed 11 months ago

Last modified 10 months ago

#18211 closed enhancement (fixed)

Enhance description of User Notes

Reported by: thomas Owned by: thomas
Priority: low Milestone: 12.0
Component: BOOK Version: git
Severity: minor Keywords:
Cc:

Description

Rainer F reported on the ML:

...
There should be a short introduction in the book what User
Notes/Hints are about and in how they differ
...

I think thats a good point, the "BLFS Wiki" page can be enhanced a bit,

Change History (6)

comment:1 by Bruce Dubbs, 11 months ago

I'm inclined to just remove that page completely.

in reply to:  1 comment:2 by thomas, 11 months ago

Replying to Bruce Dubbs:

I'm inclined to just remove that page completely.

Yea, due to the fact that only editors do edit those pages, it shrinks donw a bit (at least the the itemlist will go away). OTOH, a comment about a sporadic appearing link might be useful to the reader and we should state somewhere, that the content of those pages might be reviewed but may be outdated nevertheless. The verified instructions are on the packages page, not in the notes.

comment:3 by thomas, 11 months ago

what do you think about this one:

  <title>Editor Notes</title>

  <para>The BLFS Project has created a Wiki for editors to comment
  on pages and instructions at <ulink url='&blfs-wiki;'/>.</para>

  <para>When <emphasis>editor notes</emphasis> are present, a link 
  appears in the form <literal>&blfs-wiki;/pkgname</literal> right
  below the dependency list. The idea behind the editor notes is to
  give additional information about the package and/or its build
  instructions, common pitfalls or maybe even more sophisticated
  configuration for special cases of use.</para>

  <para>The vast majority of the packages do not have editor notes.</para>
  
  <note>
    <para>
      The <emphasis>editor notes</emphasis> might be outdated. Even the
      pages should be reviewed on a regular basis, it might happen
      that there are notes referring to an obsolete version and
      therefore, the notes might be invalid. Always check the date
      of the notes and more important, the version of the package the
      notes refer to.
    </para>
  </note>

<!--
  <para>The following are the rules for posting:
...

comment:4 by Bruce Dubbs, 11 months ago

I like that. The note should probably read:

The <emphasis>editor notes</emphasis> might be outdated. Even 
though the pages should be reviewed when a package is updated, it might happen
that there are notes referring to an obsolete version and
therefore, the notes might be out of date. Always check the date
of the notes and more importantly, the version of the package the
notes refer to.

comment:5 by thomas, 11 months ago

Resolution: fixed
Status: assignedclosed

Fixed in [4d19786e0b]

comment:6 by Bruce Dubbs, 10 months ago

Milestone: 11.412.0

Milestone renamed

Note: See TracTickets for help on using tickets.