Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 2.94 KB

READMEplus.md

File metadata and controls

98 lines (72 loc) · 2.94 KB

The ARK Identifier Scheme

This is the working area for the individual Internet-Draft, "The ARK Identifier Scheme".

Contributing

All editing is focused on just one file: draft-kunze-ark.md (formerly .xml). See the guidelines for contributions.

Contributions can be made by creating pull requests. The GitHub interface supports creating pull requests using the Edit (✏) button.

Command Line Usage

Formatted text and HTML versions of the draft can be built using make.

$ make

Review the formatted versions in the usual ways, such as,

$ more draft-kunze-ark-35.txt         # open with text-based pager
$ open draft-kunze-ark-35.html        # open with local web browser

If things get stuck in a weird state, other "make" targets may help to get them unstuck:

$ make diff
$ make lint

See features for more. Command line usage requires that you have the necessary software installed. See the instructions.

Note: For building locally on my Mac it was necessary to manually install the Ruby dependencies. Run make from the root folder once. It will install a bunch of dependencies and will likely fail when trying to run kramdown-rfc. When that happens, run the following to install the remaining dependencies:

$ export BUNDLE_PATH="$(pwd)/lib/.gems"
$ export PATH="${BUNDLE_PATH}/bin:${PATH}"
$ bundle install --gemfile="$(pwd)/lib/Gemfile"

Running make then worked as expected.

Submitting Drafts to the Official IETF Site

You can do this manually or automatically. The latter uses GitHub Actions to manage the process, which you initiate by committing and pushing the post-review draft, then pushing a tag to create a release. The tag you use has to include the full name of the draft (without the ".md" or ".xml") and ending in the next revision number, XY. So if the latest public revision number is 31, the next is 32.

$ make
$ git commit -m "cold fusion fixed"
$ git push origin main
$ git tag -a draft-kunze-ark-XY
$ git push origin draft-kunze-ark-XY

You can also track the IETF submission status.

Updating the actions

To update the actions to a newer version, or if there's a change of author email, draft title, or draft filename, manually run

$ make update
$ make update-files

which can overwrite any customizations made to the files

README.md
CONTRIBUTING.md
.note.xml
.github/CODEOWNERS
Makefile