bug-standards
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [prep/maintain] Proposed changes in maintain.texi


From: John Darrington
Subject: Re: [prep/maintain] Proposed changes in maintain.texi
Date: Sun, 17 Sep 2017 21:11:57 +0200
User-agent: Mutt/1.5.23 (2014-03-12)

I see that in addition to the new section you're proposing,  you
have also changed a lot of instances of "http" to "https".

Can you post these as separate patches?

J'

On Sun, Sep 17, 2017 at 12:26:31AM +0200, Th??r??se Godefroy wrote:
     Hello,
     
     Webmasters often have to deal with trivial bugs in package web pages:
     inexistent home page, dead links, validation errors, outdated
     boilerplate, etc. Following a discussion with RMS and John Sullivan
     (gnu.org RT #1204847), Ineiev and I modified README.webmastering.html
     [0] to explain more clearly how webmasters should handle those bugs.
     This is what we came up with ("you" refers to webmasters):
     
     "You do have the technical permission to check out any GNU (or non-GNU)
     web repository from Savannah and commit changes. However, package
     maintainers are responsible for their own pages, and thus you should not
     modify a page unless its maintainer asks you to or confirms a particular
     change. The only exception is for small changes that don't affect
     meaning, such as fixing (X)HTML validation errors, updating the page to
     the latest boilerplate, replacing a wrong bug-reporting address in the
     footer, etc. In any event, you should inform the maintainer of the change."
     
     It may be a good idea to modify prep/maintain/ accordingly. This is what
     the proposed patch is doing. It also gives a procedure to create home
     pages for newly-dubbed GNU packages, and includes recent changes to
     maintain.html that were made recently [1].
     
     Thanks for your attention to this matter.
     
     Best regards,
     Therese
     
     [0] https://gnu.org/server/standards/README.webmastering.html
     [1] https://lists.gnu.org/archive/html/www-commits/2017-09/msg00181.html

     --- maintain.texi  2016-11-04 02:58:24.000000000 +0100
     +++ maintain.texi  2017-09-16 20:21:37.765999942 +0200
     @@ -6,5 +6,5 @@
      @c @setchapternewpage odd
      @c This date is automagically updated when you save this file:
     address@hidden lastupdate November 3, 2016
     address@hidden lastupdate August 25, 2017
      @c %**end of header
      
     @@ -25,5 +25,6 @@
      Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
      2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
     -2010, 2011, 2012, 2013, 2014, 2015, 2016 Free Software Foundation, Inc.
     +2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 Free Software Foundation,
     +Inc.
      
      Permission is granted to copy, distribute and/or modify this document
     @@ -101,5 +102,5 @@
      diff for some other version of this document, or propose it in any way
      that makes it clear.  The source repository for this document can be
     -found at @url{http://savannah.gnu.org/projects/gnustandards}.
     +found at @url{https://savannah.gnu.org/projects/gnustandards}.
      
      @cindex @code{gnustandards-commit@@gnu.org} mailing list
     @@ -107,5 +108,5 @@
      join the mailing list @code{gnustandards-commit@@gnu.org}, for
      instance via the web interface at
     address@hidden://lists.gnu.org/mailman/listinfo/gnustandards-commit}.
     address@hidden://lists.gnu.org/mailman/listinfo/gnustandards-commit}.
      Archives are also available there.
      
     @@ -140,5 +141,5 @@
      you have any organizational questions or concerns you can contact the
      committee at @email{gnu-advisory@@gnu.org}.  See
     address@hidden://www.gnu.org/contact/gnu-advisory.html} for the current
     address@hidden://www.gnu.org/contact/gnu-advisory.html} for the current
      committee members.  Additional information is in
      @file{/gd/gnuorg/advisory}.
     @@ -146,9 +147,9 @@
      @cindex down, when GNU machines are
      @cindex outage, of GNU machines
     address@hidden @url{https://pumprock.net/fsfstatus}
     address@hidden @url{https://quitter.se/fsfstatus}
      If you find that any GNU computer systems (@code{fencepost.gnu.org},
      @code{ftp.gnu.org}, @code{www.gnu.org}, @code{savannah.gnu.org},
      @dots{}) seem to be down, you can check the current status at
     address@hidden://pumprock.net/fsfstatus}.  Most likely the problem, if
     address@hidden://quitter.se/fsfstatus}.  Most likely the problem, if
      it can be alleviated at the FSF end, is already being worked on.
      
     @@ -174,8 +175,8 @@
      @code{fencepost.gnu.org}.  If you are the maintainer of a GNU package,
      you should have an account there.  If you don't have one already, see
     address@hidden://www.gnu.org/software/README.accounts.html}.  You can also
     address@hidden://www.gnu.org/software/README.accounts.html}.  You can also
      ask for accounts for people who significantly help you in working on
      the package.  Such GNU login accounts include email
     -(see @url{http://www.fsf.org/about/systems/sending-mail-via-fencepost}).
     +(see @url{https://www.fsf.org/about/systems/sending-mail-via-fencepost}).
      @end macro
      
     @@ -183,5 +184,5 @@
      
      Other resources available to GNU maintainers are described at
     address@hidden://www.gnu.org/software/devel.html}, as well as throughout
     address@hidden://www.gnu.org/software/devel.html}, as well as throughout
      this document.  In brief:
      
     @@ -263,5 +264,5 @@
      
      We're happy to acknowledge all major contributors to GNU packages on
     -the @url{http://www.gnu.org/people/people.html} web page.  Please send
     +the @url{https://www.gnu.org/people/people.html} web page.  Please send
      an entry for yourself to @email{webmasters@@gnu.org}, and feel free to
      suggest it to other significant developers on your package.
     @@ -358,5 +359,5 @@
      the directory @file{/gd/gnuorg/Copyright/}; they are also available
      from the @file{doc/Copyright/} directory of the @code{gnulib} project
     -at @url{http://savannah.gnu.org/projects/gnulib}.  This section
     +at @url{https://savannah.gnu.org/projects/gnulib}.  This section
      explains which templates you should use in which circumstances.
      @strong{Please don't use any of the templates except for those listed
     @@ -426,5 +427,5 @@
      example; @pxref{Internationalization,,, standards, GNU Coding
      Standards}), use @file{disclaim.translation}.  If you make use of the
     -Translation Project (@url{http://translationproject.org}) facilities,
     +Translation Project (@url{https://translationproject.org}) facilities,
      please check with the TP coordinators that they have sent the
      contributor the papers; if they haven't, then you should send the
     @@ -793,5 +794,5 @@
      @pxref{License Notices for Code}).  If a GNU library provides unique
      functionality, however, the GNU GPL should be used.
     address@hidden://www.gnu.org/licenses/why-not-lgpl.html} discusses this
     address@hidden://www.gnu.org/licenses/why-not-lgpl.html} discusses this
      strategic choice.
      
     @@ -828,5 +829,5 @@
      You should have received copies of the GNU General Public License and
      the GNU Lesser General Public License along with this program.  If
     -not, see @url{http://www.gnu.org/licenses/}.
     +not, see @url{https://www.gnu.org/licenses/}.
      @end smallexample
      
     @@ -843,10 +844,10 @@
      @itemize @bullet
      @item
     address@hidden://www.gnu.org/licenses/}.
     address@hidden://www.gnu.org/licenses/}.
      
      @item
      The @code{gnulib} project on @code{savannah.gnu.org}, which you
      can access via anonymous Git or CVS.  See
     address@hidden://savannah.gnu.org/projects/gnulib}.
     address@hidden://savannah.gnu.org/projects/gnulib}.
      
      @end itemize
     @@ -879,5 +880,5 @@
      
      You should have received a copy of the GNU General Public License
     -along with this program.  If not, see @url{http://www.gnu.org/licenses/}.
     +along with this program.  If not, see @url{https://www.gnu.org/licenses/}.
      @end quotation
      
     @@ -897,5 +898,5 @@
      
      You should have received a copy of the GNU General Public License
     -along with this program.  If not, see @url{http://www.gnu.org/licenses/}.
     +along with this program.  If not, see @url{https://www.gnu.org/licenses/}.
      @end quotation
      
     @@ -903,5 +904,5 @@
      (@pxref{Licensing of GNU Packages}), insert the word ``Lesser'' before
      ``General'' in @emph{all three} places.
     address@hidden://@/www.gnu.org/@/licenses/@/gpl-howto.html} discusses 
application
     address@hidden://@/www.gnu.org/@/licenses/@/gpl-howto.html} discusses 
application
      the GPL in more detail.
      
     @@ -942,5 +943,5 @@
      @xref{GNU Sample Texts,,, texinfo, Texinfo}, for a full example in a
      Texinfo manual, and see
     address@hidden://www.gnu.org/licenses/fdl-howto.html} for more advice about
     address@hidden://www.gnu.org/licenses/fdl-howto.html} for more advice about
      how to use the GNU FDL.
      
     @@ -1127,5 +1128,5 @@
      you don't have access to one of these platforms, as a GNU maintainer
      you can get access to the general GNU login machine; see
     address@hidden://www.gnu.org/software/README.accounts.html}.
     address@hidden://www.gnu.org/software/README.accounts.html}.
      
      Supporting other platforms is optional---we do it when that seems like
     @@ -1218,5 +1219,5 @@
      edit @file{/com/mailer/aliases} on the main GNU server.  If you don't
      have an account there, please read
     address@hidden://www.gnu.org/software/README.accounts.html} (@pxref{GNU
     address@hidden://www.gnu.org/software/README.accounts.html} (@pxref{GNU
      Accounts and Resources}).
      
     @@ -1282,9 +1283,9 @@
      useful for your package.
      
     address@hidden @url{http://bugs.gnu.org}
     address@hidden @url{https://bugs.gnu.org}
      @cindex bug reports, email tracker for
      @cindex bug reports, web tracker for
      If you would like to use an email-based bug tracking system, see
     address@hidden://bugs.gnu.org}; this can be connected with the regular
     address@hidden://bugs.gnu.org}; this can be connected with the regular
      bug-reporting address.  Alternatively, if you would like to use a
      web-based bug tracking system, Savannah supports this (@pxref{Old
     @@ -1316,5 +1317,5 @@
      Savannah is managed by @email{savannah-hackers@@gnu.org}.  For more
      details on using and contributing to Savannah, see
     address@hidden://savannah.gnu.org/maintenance}.
     address@hidden://savannah.gnu.org/maintenance}.
      
      It's not an absolute requirement, but all GNU maintainers are strongly
     @@ -1328,5 +1329,5 @@
      If you do use Savannah, please subscribe to the
      @email{savannah-announce@@gnu.org} mailing list
     -(@url{http://lists.gnu.org/mailman/listinfo/savannah-announce}).  This
     +(@url{https://lists.gnu.org/mailman/listinfo/savannah-announce}).  This
      is a very low-volume list to keep Savannah users informed of system
      upgrades, problems, and the like.
     @@ -1450,5 +1451,5 @@
      those non-free platforms trample their freedom.  It is useful to refer
      them to
     
address@hidden://www.gnu.org/philosophy/free-software-even-more-important.html}.
     
address@hidden://www.gnu.org/philosophy/free-software-even-more-important.html}.
      You can say, ``This program respects your freedom, but Windows does
      not.  To have freedom, you need to stop using Windows and other
     @@ -1554,7 +1555,7 @@
      @enumerate
      @item
     -Create an account for yourself at @url{http://savannah.gnu.org}, if
     +Create an account for yourself at @url{https://savannah.gnu.org}, if
      you don't already have one.  By the way, this is also needed to
     -maintain the web pages at @url{http://www.gnu.org} for your project
     +maintain the web pages at @url{https://www.gnu.org} for your project
      (@pxref{Web Pages}).
      
     @@ -1571,5 +1572,5 @@
      @var{keyid} is the eight hex digits reported by @code{gpg
      --list-public-keys} on the @code{pub} line before the date.  For full
     -information about GPG, see @url{http://www.gnu.org/software/gpg}.
     +information about GPG, see @url{https://www.gnu.org/software/gpg}.
      
      @item
     @@ -1649,5 +1650,5 @@
      use the @code{gnupload} script, which is available from the
      @file{build-aux/} directory of the @code{gnulib} project at
     address@hidden://savannah.gnu.org/projects/gnulib}.  Run
     address@hidden://savannah.gnu.org/projects/gnulib}.  Run
      @address@hidden for a description and examples.  (With
      @code{gnupload}, you specify a destination such as
     @@ -1772,7 +1773,7 @@
      the directory @file{gnu/foo/} on @code{ftp.gnu.org}.  That is, we'll
      have made our release available at
     address@hidden://ftp.gnu.org/gnu/foo/foo-1.0.tar.gz} (and then from
     address@hidden://ftp.gnu.org/gnu/foo/foo-1.0.tar.gz} (and then from
      our many mirrors via
     address@hidden://ftpmirror.gnu.org/foo/foo-1.0.tar.gz}).  Whew.
     address@hidden://ftpmirror.gnu.org/foo/foo-1.0.tar.gz}).  Whew.
      
      A common reason for the upload not succeeding is your GPG signature
     @@ -1935,5 +1936,5 @@
      If all you want to do is reduce how much stuff is in your release
      directory, an alternative is to email @email{sysadmin@@fsf.org} and
     -ask them to move old items to the @file{http://ftp.gnu.org/old-gnu/}
     +ask them to move old items to the @file{https://ftp.gnu.org/old-gnu/}
      directory; then they will still be available.  In general, however, we
      recommend leaving all official releases in the main release directory.
     @@ -1991,5 +1992,5 @@
      highly unusual situation.
      
     address@hidden @url{http://planet.gnu.org}
     address@hidden @url{https://planet.gnu.org}
      @cindex Savannah, news area
      Please also post release announcements in the news section of your
     @@ -1997,5 +1998,5 @@
      for test releases and any other newsworthy events.  The news feeds
      from all GNU projects at savannah are aggregated at
     address@hidden://planet.gnu.org} (GNU Planet), unless the text of the entry
     address@hidden://planet.gnu.org} (GNU Planet), unless the text of the entry
      contains the string @samp{::noplanet::}.  You can also post items
      directly, or arrange for feeds from other locations; see information
     @@ -2019,12 +2020,12 @@
      @item
      Your package's web page (normally
     address@hidden://www.gnu.org/software/@var{package}/}).
     address@hidden://www.gnu.org/software/@var{package}/}).
      
      @item
      Your package's download location (normally
     address@hidden://ftp.gnu.org/gnu/@var{package}/}).  It is also
     address@hidden://ftp.gnu.org/gnu/@var{package}/}).  It is also
      useful to mention the mirror list at
     address@hidden://www.gnu.org/order/ftp.html}, and that
     address@hidden://ftpmirror.gnu.org/@var{package/}} will automatically
     address@hidden://www.gnu.org/order/ftp.html}, and that
     address@hidden://ftpmirror.gnu.org/@var{package/}} will automatically
      redirect to a nearby mirror.
      
     @@ -2037,5 +2038,5 @@
      announcements, which is available from the @file{build-aux/} directory
      of the @code{gnulib} project at
     address@hidden://savannah.gnu.org/projects/gnulib}.
     address@hidden://savannah.gnu.org/projects/gnulib}.
      
      
     @@ -2044,14 +2045,29 @@
      @cindex web pages
      
     -Please write web pages about your package, and install them on
     address@hidden  They should follow our usual standards for web
     -pages (see @url{http://www.gnu.org/server/@/fsf-html-style-sheet.html}).
     -The overall goals are to support a wide variety of browsers, to focus
     -on information rather than flashy eye candy, and to keep the site
     -simple and uniform.
     +As soon as a new package is dubbed GNU, its home page
     +(@indicateurl{https://www.gnu.org/software/@var{package}/})
     +is listed on
     address@hidden://www.gnu.org/software/software.html} and
     address@hidden://www.gnu.org/manual/manual.html}.  To avoid broken links,
     +the webmasters create a temporary home page as follows:
      
     -We encourage you to use the standard @code{www.gnu.org} template as
     -the basis for your pages:
     address@hidden://www.gnu.org/server/@/standards/@/boilerplate-source.html}.
     address@hidden @bullet
     address@hidden
     +If there is a Savannah project for this package (@pxref{Hosting for
     +Web Pages}), the temporary home page redirects to the project's main
     +page, @indicateurl{https://savannah.gnu.org/projects/@var{package}},
     +where a short description is normally available.
     +
     address@hidden
     +If the package is described on a different web site, the
     +temporary page redirects to it.
     +
     address@hidden
     +Otherwise, the webmasters make a simple home page containing the short
     +description provided with the original submission of the package to GNU.
     address@hidden itemize
     +
     +This temporary home page must be replaced with the real one as soon
     +as possible.
      
      Some GNU packages have just simple web pages, but the more information
     @@ -2062,6 +2078,19 @@
      on @code{www.gnu.org} link to that site.
      
     +Your web pages should follow our usual standards for web
     +pages (see @url{https://www.gnu.org/server/@/fsf-html-style-sheet.html}).
     +The overall goals are to support a wide variety of browsers, to focus
     +on information rather than flashy eye candy, and to keep the site
     +simple and uniform.
     +
     +We encourage you to use the standard @code{www.gnu.org} template as
     +the basis for your pages:
     address@hidden://www.gnu.org/server/@/standards/@/boilerplate-source.html}.
     +This template changes slightly from time to time for various reasons. If
     +a change affects existing web pages, you will be notified and provided
     +with a patch. Please apply it as soon as possible.
     +
      Please follow the best practices of accessibility in your web pages
     -(see @url{http://www.gnu.org/accessibility/accessibility.html}).
     +(see @url{https://www.gnu.org/accessibility/accessibility.html}).
      
      @menu
     @@ -2080,5 +2109,5 @@
      using CVS, using the separate ``web pages repository'' available on
      Savannah, which corresponds to
     address@hidden://www.gnu.org/software/@var{package}/}.  You can
     address@hidden://www.gnu.org/software/@var{package}/}.  You can
      keep your source files there too (using any of a variety of version
      control systems), but you can use @code{savannah.gnu.org} only for
     @@ -2091,8 +2120,13 @@
      is more work for them, so please use Savannah if you can.
      
     +Please note that the GNU webmasters may fix technical details in your
     +web pages (HTML, CSS, obvious typos, broken links in the footer, etc.)
     +and inform you of the change afterwards.  However, they will not modify
     +your text without your agreement.
     +
      If you use Savannah, you can use a special file named @file{.symlinks}
      in order to create symbolic links, which are not supported in CVS.
      For details, see
     
address@hidden://www.gnu.org/server/standards/README.webmastering.html#symlinks}.
     
address@hidden://www.gnu.org/server/standards/README.webmastering.html#symlinks}.
      
      
     @@ -2118,9 +2152,9 @@
      Consideration}).  Although the GIF patents expired in 2006, using GIF
      images is still not recommended, as the PNG and JPEG formats are
     -generally superior.  See @url{http://www.gnu.org/philosophy/gif.html}.
     +generally superior.  See @url{https://www.gnu.org/philosophy/gif.html}.
      
      Please make sure that any Javascript code in your web pages is covered
      by a free license, and has its license indicated in a way LibreJS can
     -recognize.  See @url{http://gnu.org/philosophy/javascript-trap.html}.
     +recognize.  See @url{https://gnu.org/philosophy/javascript-trap.html}.
      If the Javascript in the page is minified, or for any other reason is
      not the source code, it must point to its source code as described
     @@ -2151,5 +2185,5 @@
      
      We would like to list all GNU manuals on the page
     address@hidden://www.gnu.org/manual}, so if yours isn't there, please send
     address@hidden://www.gnu.org/manual}, so if yours isn't there, please send
      mail to @code{webmasters@@gnu.org}, asking them to add yours, and they
      will do so based on the contents of your @file{manual} directory.
     @@ -2173,6 +2207,6 @@
      
      @smallformat
     
address@hidden://git.savannah.gnu.org/cgit/gnulib.git/tree/build-aux/gendocs.sh}
     
address@hidden://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/gendocs_template}
     
address@hidden://git.savannah.gnu.org/cgit/gnulib.git/tree/build-aux/gendocs.sh}
     
address@hidden://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/gendocs_template}
      @end smallformat
      
     @@ -2180,5 +2214,5 @@
      
      @smallformat
     
address@hidden://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/gendocs_template_min}
     
address@hidden://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/gendocs_template_min}
      @end smallformat
      
     @@ -2285,5 +2319,5 @@
      @c form, so it's not worth trying to give a direct link.
      See the ``Keyword Substitution'' section in the CVS manual, available
     -from @url{http://cvs.nongnu.org}.
     +from @url{https://cvs.nongnu.org}.
      
      In Texinfo source, the recommended way to literally specify a
     @@ -2344,5 +2378,5 @@
      ethical concerns should be used, such as GNU's Pootle instance
      (@url{https://chapters.gnu.org/pootle}) or The Translation Project
     -(@url{http://translationproject.org}).
     +(@url{https://translationproject.org}).
      
      A GNU package should not refer the user to any non-free documentation
     @@ -2398,5 +2432,5 @@
      associated with a philosophy which studiously avoids such questions.
      For a detailed explanation, see
     address@hidden://www.gnu.org/philosophy/open-source-misses-the-point.html}.
     address@hidden://www.gnu.org/philosophy/open-source-misses-the-point.html}.
      
      The GNU Project is aligned with the free software movement.  This
     @@ -2442,5 +2476,5 @@
      role as the maintainer of a GNU package.  If you want to explain the
      terminology and its reasons, you can refer to the URL
     address@hidden://www.gnu.org/gnu/linux-and-gnu.html}.
     address@hidden://www.gnu.org/gnu/linux-and-gnu.html}.
      
      To make it clear that Linux is a kernel, not an operating system,
     @@ -2465,5 +2499,5 @@
      
      For more about this point, see
     address@hidden://www.gnu.org/gnu/gnu-linux-faq.html}.
     address@hidden://www.gnu.org/gnu/gnu-linux-faq.html}.
      
      @node Interviews and Speeches
     @@ -2486,14 +2520,14 @@
      @item
      What GNU is (an operating system developed to be Unix-like and totally
     -free software).  It is good to mention @url{http://www.gnu.org}.
     +free software).  It is good to mention @url{https://www.gnu.org}.
      
      @item
      What free software is (the users control it, so it doesn't control
      them).  It is good to state the four freedoms and/or refer to
     address@hidden://www.gnu.org/philosophy/free-sw.html}.
     address@hidden://www.gnu.org/philosophy/free-sw.html}.
      
      @item
      What GNU/Linux is (Linux filled the last gap in GNU).  It is useful to
     -refer to @url{http://www.gnu.org/gnu/linux-and-gnu.html}.
     +refer to @url{https://www.gnu.org/gnu/linux-and-gnu.html}.
      
      @item
     @@ -2567,8 +2601,8 @@
      "free software" because you are free to copy and redistribute them,
      following the rules stated in the license of each package.  For more
     -information, see http://www.gnu.org/philosophy/free-sw.html.
     +information, see https://www.gnu.org/philosophy/free-sw.html.
      
      If you are looking for service or support for GNU software, see
     -http://www.gnu.org/gethelp/ for suggestions of where to ask.
     +https://www.gnu.org/gethelp/ for suggestions of where to ask.
      
      If you would like to contribute to the development of one of these
     @@ -2632,5 +2666,5 @@
      
      Of course, it is also good to encourage people to join the FSF
     -(@url{http://www.fsf.org}) or make a general donation, either instead
     +(@url{https://www.fsf.org}) or make a general donation, either instead
      of or as well as package-specific donations.
      
     @@ -2644,5 +2678,5 @@
      software packages, within certain criteria.  Every GNU package should
      be listed there, so please see
     address@hidden://www.gnu.org/help/directory.html#adding-entries} for
     address@hidden://www.gnu.org/help/directory.html#adding-entries} for
      information on how to write an entry for your package.  Contact
      @email{bug-directory@@gnu.org} with any questions or suggestions for
     


-- 
Avoid eavesdropping.  Send strong encrypted email.
PGP Public key ID: 1024D/2DE827B3 
fingerprint = 8797 A26D 0854 2EAB 0285  A290 8A67 719C 2DE8 27B3
See http://sks-keyservers.net or any PGP keyserver for public key.

Attachment: signature.asc
Description: Digital signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]