Skip to content

Commit

Permalink
Merge pull request #19 from jimsch/master
Browse files Browse the repository at this point in the history
Create a real README file
  • Loading branch information
henkbirkholz committed Jul 23, 2015
2 parents e3f5787 + a4f386c commit ace5ff1
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 7 deletions.
8 changes: 2 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@

.refcache/reference.RFC.5209.xml

.refcache/reference.RFC.3444.xml

.refcache/reference.RFC.4949.xml
# Ignore items in this directory
.refcache
96 changes: 96 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# SACM Terminology

This is the working area for the IETF SACM terminology draft.

* [Working Group Draft] (https://tools.ietf.org/html/draft-ietf-sacm-terminology)

## Contributing

Before submitting feedback, please familiarize yourself with our current issues
list and review the [SACM Working Group](https://datatracker.ietf.org/wg/sacm/charter/). If you're
new to this, you may also want to read the [Tao of the
IETF](https://www.ietf.org/tao.html).

Be aware that all contributions to the specification fall under the "NOTE WELL"
terms outlined below.

1. The best way to provide feedback (editorial or design) and ask questions is
sending an e-mail to sacm@ietf.org (https://www.ietf.org/mailman/listinfo/SACM). This will ensure that
the entire Working Group sees your input in a timely fashion.

2. If you have **editorial** suggestions (i.e., those that do not change the
meaning of the specification), you can either:

a) Fork this repository and submit a pull request; this is the lowest
friction way to get editorial changes in.

b) Submit a new issue to Github, and mention that you believe it is editorial
in the issue body. It is not necessary to notify the mailing list for
editorial issues.

c) Make comments on individual commits in Github. Note that this feedback is
processed only with best effort by the editors, so it should only be used for
quick editorial suggestions or questions.

3. For non-editorial (i.e., **design**) issues, you can also create an issue on
Github. However, you **must notify the mailing list** when creating such issues,
providing a link to the issue in the message body.

Note that **github issues are not for substantial discussions**; the only
appropriate place to discuss design issues is on the mailing list itself.


## Building the Draft

In order to build a copy of the draft, you will need to install xml2rfc. This
requires Python 2.7 and can be installed using `pip`:

```sh
$ pip install xml2rfc
```

You may also need to install kramdown-xml2rfc, which requires Ruby and can be installed using the roby package manager, gem:


```sh
-$ gem install kramdown-xml2rfc
```

Other tools can be used to produce PDF files, or to provide a comparison. These
tools - and where to find them - are described in the `Makefile`.


## NOTE WELL

Any submission to the [IETF](https://www.ietf.org/) intended by the Contributor
for publication as all or part of an IETF Internet-Draft or RFC and any
statement made within the context of an IETF activity is considered an "IETF
Contribution". Such statements include oral statements in IETF sessions, as
well as written and electronic communications made at any time or place, which
are addressed to:

* The IETF plenary session
* The IESG, or any member thereof on behalf of the IESG
* Any IETF mailing list, including the IETF list itself, any working group
or design team list, or any other list functioning under IETF auspices
* Any IETF working group or portion thereof
* Any Birds of a Feather (BOF) session
* The IAB or any member thereof on behalf of the IAB
* The RFC Editor or the Internet-Drafts function
* All IETF Contributions are subject to the rules of
[RFC 5378](https://tools.ietf.org/html/rfc5378) and
[RFC 3979](https://tools.ietf.org/html/rfc3979)
(updated by [RFC 4879](https://tools.ietf.org/html/rfc4879)).

Statements made outside of an IETF session, mailing list or other function,
that are clearly not intended to be input to an IETF activity, group or
function, are not IETF Contributions in the context of this notice.

Please consult [RFC 5378](https://tools.ietf.org/html/rfc5378) and [RFC
3979](https://tools.ietf.org/html/rfc3979) for details.

A participant in any IETF activity is deemed to accept all IETF rules of
process, as documented in Best Current Practices RFCs and IESG Statements.

A participant in any IETF activity acknowledges that written, audio and video
records of meetings may be made and may be available to the public.
1 change: 0 additions & 1 deletion readme.txt

This file was deleted.

0 comments on commit ace5ff1

Please sign in to comment.