You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@whimsical.apache.org by cu...@apache.org on 2017/06/23 14:09:56 UTC
[whimsy] branch master updated (a091c57 -> c40c366)
This is an automated email from the ASF dual-hosted git repository.
curcuru pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git.
from a091c57 s/person/user/
new dcadaa7 Document some docs
new c40c366 Use ISERR to make it clear where it's coming from
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
DEVELOPMENT.md | 24 ++++++++++++++++++++++++
README.md | 3 ++-
tools/wwwdocs.rb | 2 +-
3 files changed, 27 insertions(+), 2 deletions(-)
--
To stop receiving notification emails like this one, please contact
['"commits@whimsical.apache.org" <co...@whimsical.apache.org>'].
[whimsy] 02/02: Use ISERR to make it clear where it's coming from
Posted by cu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
curcuru pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git
commit c40c36630fcb0c9169b64a346df685b7a846d9e3
Author: Shane Curcuru <as...@shanecurcuru.org>
AuthorDate: Fri Jun 23 10:09:50 2017 -0400
Use ISERR to make it clear where it's coming from
---
tools/wwwdocs.rb | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tools/wwwdocs.rb b/tools/wwwdocs.rb
index 5a690f9..e85c408 100755
--- a/tools/wwwdocs.rb
+++ b/tools/wwwdocs.rb
@@ -23,7 +23,7 @@ def scan_file(f)
end
return nil
rescue Exception => e
- return ["!Bogosity! #{e.message[0..255]}", "\t#{e.backtrace.join("\n\t")}"]
+ return ["#{ISERR}Bogosity! #{e.message[0..255]}", "\t#{e.backtrace.join("\n\t")}"]
end
end
--
To stop receiving notification emails like this one, please contact
"commits@whimsical.apache.org" <co...@whimsical.apache.org>.
[whimsy] 01/02: Document some docs
Posted by cu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
curcuru pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git
commit dcadaa7fa9a50ec2f5c5495b2d35078d551476d2
Author: Shane Curcuru <as...@shanecurcuru.org>
AuthorDate: Fri Jun 23 10:09:18 2017 -0400
Document some docs
Nice new RDocs thanks to @rubys
---
DEVELOPMENT.md | 24 ++++++++++++++++++++++++
README.md | 3 ++-
2 files changed, 26 insertions(+), 1 deletion(-)
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 7a25639..160fa89 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -16,6 +16,7 @@ Contents :books:
- [Advanced Configuration](#advanced-configuration)
- [Server Configuration](DEPLOYMENT.md)
- [Further Reading](#further-reading)
+- [Documentation Standards](#documentation-standards)
- [How To / FAQ](#how-to--faq-question)
- [Running Whimsy on Mac OSX](MACOSX.md)
- [Running Whimsy on Windows](#whimsy-on-windows)
@@ -247,6 +248,29 @@ a virtual host, complete with authentication:
More details about the production Whimsy instance are in [DEPLOYMENT.md](DEPLOYMENT.md)
+Documentation Standards
+============
+
+As a collection of semi-independent tools, Whimsy has a number of
+different ways to document code or functionality for users.
+
+- **RDoc for whimsy/asf module** The Rakefile has an RDoc task that now
+ processes the lib/whimsy/ directory, which can be run locally, and
+ is run automatically on the server into https://whimsy.apache.org/docs/api/
+
+- **End user instructions** are provided in many tools by defining a
+ `PAGETITLE` and a `helpblock ->` which are put into a consistent place
+ on the page for users when using whimsy/asf/themes. This information
+ is also parsed to generate a committer-only
+ [listing of useful Whiimsy tools](https://whimsy.apache.org/committers/tools).
+
+- **Data dependencies** and the flow of data between different Whimsy
+ processes and other websites are described in [test/dataflow.cgi](https://whimsy.apache.org/test/dataflow.cgi)
+
+- **How-To for whimsy committers** are what you're reading right here
+ in DEVELOPMENT.md and in DEPLOYMENT.md, CONFIGURE.md, MACOSX.md
+
+
How To / FAQ :question:
============
diff --git a/README.md b/README.md
index ef73760..97869be 100644
--- a/README.md
+++ b/README.md
@@ -71,7 +71,8 @@ that directly interface with various parts of Apache organziational records.
Details for each type of deployed tool or script:
* **Static content** Changes pushed to GitHub master will be
- automatically deployed every 30 minutes. Note that this includes the
+ automatically deployed - every commit triggers the puppet agent to
+ do an update, which may take a few minutes. Note that this includes the
contents of scripts and applications too.
* **Repository checkouts/clones** An copy of a number of repositories
--
To stop receiving notification emails like this one, please contact
"commits@whimsical.apache.org" <co...@whimsical.apache.org>.