olddoc user/dev discussion/patches/bugs/etc
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: olddoc-public@80x24.org
Subject: [PATCH 1/3] support for nntp_url, make private_email optional
Date: Thu, 15 Oct 2015 01:04:51 +0000	[thread overview]
Message-ID: <20151015010453.24454-2-e@80x24.org> (raw)
In-Reply-To: <20151015010453.24454-1-e@80x24.org>

Not every project needs private email.  Maybe none do.
While we're at it, fix our own .olddoc.yml to show ml_url.
---
 .olddoc.yml                | 3 ++-
 Documentation/olddoc.5.txt | 6 +++++-
 lib/oldweb/_tail.rhtml     | 8 ++++++--
 olddoc.gemspec             | 2 +-
 4 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/.olddoc.yml b/.olddoc.yml
index 0b37154..41f3cf8 100644
--- a/.olddoc.yml
+++ b/.olddoc.yml
@@ -2,8 +2,9 @@
 cgit_url: http://bogomips.org/olddoc.git
 git_url: git://80x24.org/olddoc.git
 rdoc_url: http://80x24.org/olddoc/
+ml_url: http://80x24.org/olddoc-public/
+nntp_url: nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
 merge_html:
   olddoc_1: Documentation/olddoc.1.html
   olddoc_5: Documentation/olddoc.5.html
 public_email: olddoc-public@80x24.org
-private_email: olddoc@80x24.org
diff --git a/Documentation/olddoc.5.txt b/Documentation/olddoc.5.txt
index 0b95578..50b6713 100644
--- a/Documentation/olddoc.5.txt
+++ b/Documentation/olddoc.5.txt
@@ -15,12 +15,16 @@ configuration to deal with.
 
 # KEYS
 
-`rdoc_url`, `cgit_url` should be obvious
+`rdoc_url`, `cgit_url`, and `nntp_url` should be obvious
 
 `merge_html` is a key-value mapping of (empty) RDoc source files to an
 HTML file that will be merged into RDoc after-the-fact.  It is useful
 for merging non-RDoc generated HTML into the project.
 
+`ml_url` is the mailing list archive location.
+`public_email` is the email address of a publically archived mailing list
+at `ml_url`
+
 # SEE ALSO
 
 olddoc(1)
diff --git a/lib/oldweb/_tail.rhtml b/lib/oldweb/_tail.rhtml
index d1fc7e5..522c312 100644
--- a/lib/oldweb/_tail.rhtml
+++ b/lib/oldweb/_tail.rhtml
@@ -2,11 +2,12 @@
 public_email = @old_cfg['public_email']
 private_email = @old_cfg['private_email']
 ml_url = @old_cfg['ml_url']
+nntp_url = @old_cfg['nntp_url']
 git_doc = 'https://kernel.org/pub/software/scm/git/docs/'
 se_url = "#{git_doc}git-send-email.html"
 rp_url = "#{git_doc}git-request-pull.html"
 
-if public_email && private_email && ml_url %><hr /><p>
+if public_email && ml_url %><hr /><p>
 We love to hear from you!<br />
 Email patches (using <a
 href="<%= se_url %>">git send-email</a>),
@@ -19,7 +20,10 @@ href="<%= ml_url %>"><%= ml_url %></a><br />
 Please send plain-text email only and do not waste bandwidth on HTML mail,
 HTML mail will not be read.<br />
 Quote as little as reasonable and do not <a
-href="http://catb.org/jargon/html/T/top-post.html">top post</a>.<br />
+href="http://catb.org/jargon/html/T/top-post.html">top post</a>.<br /><% end
+if nntp_url %>NNTP archives are available at: <a
+href="<%= nntp_url %>"><%= nntp_url %></a><% end
+if private_email %>
 For sensitive topics, email us privately at:
 <a
 href="mailto:<%= private_email %>"><%= private_email %></a><% end %>
diff --git a/olddoc.gemspec b/olddoc.gemspec
index 17b5fa8..11e0a29 100644
--- a/olddoc.gemspec
+++ b/olddoc.gemspec
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.authors = ["#{s.name} hackers"]
   s.summary = summary
   s.description = readme_description
-  s.email = Olddoc.config['private_email']
+  s.email = 'e@80x24.org'
   s.files = manifest
   s.add_dependency('rdoc', '~> 4.2')
   s.add_dependency('builder', '~> 3.2')
-- 
EW


  reply	other threads:[~2015-10-15  1:04 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-15  1:04 [PATCH 0/3] minor updates in preparation for olddoc 1.1.0 Eric Wong
2015-10-15  1:04 ` Eric Wong [this message]
2015-10-15  1:04 ` [PATCH 2/3] gemspec: use SPDX-compatible license Eric Wong
2015-10-15  1:04 ` [PATCH 3/3] readme: relax dependency on RDoc formatting Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://80x24.org/olddoc/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20151015010453.24454-2-e@80x24.org \
    --to=e@80x24.org \
    --cc=olddoc-public@80x24.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/olddoc.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).