Skip to content

Commit

Permalink
rfdlint: Add it to a 'make check'. Prefer %22 URL-encoding for quotes…
Browse files Browse the repository at this point in the history
… in discussion links so apps link up better.
  • Loading branch information
trentm committed Jul 19, 2017
1 parent c372885 commit 2e5162c
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 13 deletions.
17 changes: 17 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#

#
# Copyright (c) 2017, Joyent, Inc.
#

.PHONY: all
all:

.PHONY: check
check:
./tools/rfdlint
@echo "check ok"
2 changes: 1 addition & 1 deletion rfd/0100/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: Cody Mello <[email protected]>
state: predraft
discussion: https://github.com/joyent/rfd/issues?q=\"RFD+100\"
discussion: https://github.com/joyent/rfd/issues?q=%22RFD+100%22
---

<!--
Expand Down
5 changes: 2 additions & 3 deletions rfd/0101/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: Bryan Cantrill <[email protected]>
state: draft
discussion: https://github.com/joyent/rfd/issues?q="RFD+101"
discussion: https://github.com/joyent/rfd/issues?q=%22RFD+101%22
---

<!--
Expand Down Expand Up @@ -53,7 +53,7 @@ life: socializing must be limited, travel must be eliminated, presentations
time) must be canceled, etc. This can be very stressful -- even if an
engineer is never, in fact, called.

* **It doesn't necessarily solve the problem.** Because escalation into
* **It doesn't necessarily solve the problem.** Because escalation into
engineering is (tautologically) due to a problem outside of the system's
designed parameters, one cannot know that the engineer who
happens to be on call will be able to root-cause the problem. Indeed, it
Expand Down Expand Up @@ -128,4 +128,3 @@ Engineering escalation is a regretable necessity of any software deployed
as a service; the Code Blue model is -- as Churchill famously described
democracy -- probably the worst escalation model except for all of the
others.

9 changes: 4 additions & 5 deletions rfd/0102/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: Bryan Cantrill <[email protected]>
state: publish
discussion: https://github.com/joyent/rfd/issues?q="RFD+102"
discussion: https://github.com/joyent/rfd/issues?q=%22RFD+102%22
---

<!--
Expand Down Expand Up @@ -61,10 +61,10 @@ success?
There is an art to describing the problem that needs to be solved: too
vague, and one runs the risk of putative solutions that don't actually
solve the problem; too specific and the problem description drifts into
a solution description. Ideally, the problem description should be
a solution description. Ideally, the problem description should be
abstract and yet still sufficiently concrete to constrain (but not overly
constrain!) solutions. For example, an RFE asking for a GPGPU-based
container offering (say) is vague and likely underspecified -- but
container offering (say) is vague and likely underspecified -- but
one asking for
an offering based on NVIDIA Tesla P100 GPUs may be too confining.
Rather, the RFE may be for GPGPU-based container offering that allows
Expand Down Expand Up @@ -151,11 +151,10 @@ describe -- in narrative form -- what the software should do from a
user's perspective. ("As a user, I would like to create a container that
is attached to a GPGPU instance.") While RFEs may very well look like an
agile story, they are likely to be more technical than what is
traditionally thought of as a story, but the technique of adding a
traditionally thought of as a story, but the technique of adding a
narrative may well be considered useful to flesh out an RFE.

## Mechanics

RFEs -- like RFDs -- are public. Like RFDs, they will have their own
public repository and numbering scheme.

7 changes: 3 additions & 4 deletions tools/rfdlint
Original file line number Diff line number Diff line change
Expand Up @@ -184,17 +184,16 @@ cat <<EOF
$prog: RFD $rfd (in $state state, $days days old) lacks 'discussion' field
$prog: if not already opened, add the following issue:
RFD $rfd: Discussion
RFD $rfd: Discussion
This issue represents an opportunity for discussion of [$title](https://github.com/joyent/rfd/tree/master/$f) while it remains in a pre-published state.
This issue represents an opportunity for discussion of [$title](https://github.com/joyent/rfd/tree/master/$f) while it remains in a pre-published state.
$prog: Then add to metadata section in ./$f:
discussion: https://github.com/joyent/rfd/issues?q=\"RFD+$rfd\"
discussion: https://github.com/joyent/rfd/issues?q=%22RFD+$rfd%22
EOF
exit 1
fi
fi
done

0 comments on commit 2e5162c

Please sign in to comment.