-
-
Notifications
You must be signed in to change notification settings - Fork 65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Convert the specification into RFC format #466
Open
jyasskin
wants to merge
14
commits into
kdl-org:main
Choose a base branch
from
jyasskin:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
41b0c5e
Initial conversion to Internet-Draft.
jyasskin 178e42e
Setup repository for draft-marchan-kdl2 using https://github.com/mart…
jyasskin 566f72a
Remove unnecessary changes.
jyasskin aa0d514
Tweak source to make the I-D build.
jyasskin fc2466d
Fix zkat's name. Guess at their preferred initials.
jyasskin dd304ee
Separate links where linking text equals the anchor.
jyasskin 76927ec
Replace horizontal rules with subsections.
jyasskin 67c0aea
Use ~~~kdl instead of `` for strings with significant whitespace.
jyasskin 4c2a70a
Give breadcrumbs to the RFC format definitions.
jyasskin 319cd2f
Point contributors to https://author-tools.ietf.org/.
jyasskin 8252031
Separate a code block from adjacent text.
jyasskin 4f32775
Remove a workflow that overwrites customized files.
jyasskin 7b397af
Remove the 'archive' workflow.
jyasskin dd1cc12
Use "Term ({{term}})" uniformly instead of just when the term matches…
jyasskin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# See http://editorconfig.org | ||
|
||
root = true | ||
|
||
[*.{md,xml,org}] | ||
charset = utf-8 | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: "Update Editor's Copy" | ||
|
||
on: | ||
push: | ||
paths-ignore: | ||
- README.md | ||
- CONTRIBUTING.md | ||
- LICENSE.md | ||
- .gitignore | ||
pull_request: | ||
paths-ignore: | ||
- README.md | ||
- CONTRIBUTING.md | ||
- LICENSE.md | ||
- .gitignore | ||
|
||
jobs: | ||
build: | ||
name: "Update Editor's Copy" | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
- name: "Checkout" | ||
uses: actions/checkout@v4 | ||
|
||
- name: "Setup" | ||
id: setup | ||
run: date -u "+date=%FT%T" >>"$GITHUB_OUTPUT" | ||
|
||
- name: "Caching" | ||
uses: actions/cache@v4 | ||
with: | ||
path: | | ||
.refcache | ||
.venv | ||
.gems | ||
node_modules | ||
.targets.mk | ||
key: i-d-${{ steps.setup.outputs.date }} | ||
restore-keys: i-d- | ||
|
||
- name: "Build Drafts" | ||
uses: martinthomson/i-d-template@v1 | ||
with: | ||
token: ${{ github.token }} | ||
|
||
- name: "Update GitHub Pages" | ||
uses: martinthomson/i-d-template@v1 | ||
if: ${{ github.event_name == 'push' }} | ||
with: | ||
make: gh-pages | ||
token: ${{ github.token }} | ||
|
||
- name: "Archive Built Drafts" | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
path: | | ||
draft-*.html | ||
draft-*.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
name: "Publish New Draft Version" | ||
|
||
on: | ||
push: | ||
tags: | ||
- "draft-*" | ||
workflow_dispatch: | ||
inputs: | ||
email: | ||
description: "Submitter email" | ||
default: "" | ||
type: string | ||
|
||
jobs: | ||
build: | ||
name: "Publish New Draft Version" | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: "Checkout" | ||
uses: actions/checkout@v4 | ||
|
||
# See https://github.com/actions/checkout/issues/290 | ||
- name: "Get Tag Annotations" | ||
run: git fetch -f origin ${{ github.ref }}:${{ github.ref }} | ||
|
||
- name: "Setup" | ||
id: setup | ||
run: date -u "+date=%FT%T" >>"$GITHUB_OUTPUT" | ||
|
||
- name: "Caching" | ||
uses: actions/cache@v4 | ||
with: | ||
path: | | ||
.refcache | ||
.venv | ||
.gems | ||
node_modules | ||
.targets.mk | ||
key: i-d-${{ steps.setup.outputs.date }} | ||
restore-keys: i-d- | ||
|
||
- name: "Build Drafts" | ||
uses: martinthomson/i-d-template@v1 | ||
with: | ||
token: ${{ github.token }} | ||
|
||
- name: "Upload to Datatracker" | ||
uses: martinthomson/i-d-template@v1 | ||
with: | ||
make: upload | ||
env: | ||
UPLOAD_EMAIL: ${{ inputs.email }} | ||
|
||
- name: "Archive Submitted Drafts" | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
path: "versioned/draft-*-[0-9][0-9].*" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,25 @@ | ||
/target | ||
Cargo.lock | ||
*.html | ||
*.redxml | ||
*.swp | ||
*.txt | ||
*.upload | ||
*~ | ||
.tags | ||
/*-[0-9][0-9].xml | ||
/.*.mk | ||
/.gems/ | ||
/.refcache | ||
/.venv/ | ||
/.vscode/ | ||
/lib | ||
/node_modules/ | ||
/versioned/ | ||
Gemfile.lock | ||
archive.json | ||
draft-marchan-kdl2.xml | ||
package-lock.json | ||
report.xml | ||
!requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
<note title="Discussion Venues" removeInRFC="true"> | ||
<t>Source for this draft and an issue tracker can be found at | ||
<eref target="https://github.com/kdl-org/kdl"/>.</t> | ||
</note> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contributing | ||
|
||
This repository relates to activities in the Internet Engineering Task Force | ||
([IETF](https://www.ietf.org/)). All material in this repository is considered | ||
Contributions to the IETF Standards Process, as defined in the intellectual | ||
property policies of IETF currently designated as | ||
[BCP 78](https://www.rfc-editor.org/info/bcp78), | ||
[BCP 79](https://www.rfc-editor.org/info/bcp79) and the | ||
[IETF Trust Legal Provisions (TLP) Relating to IETF Documents](http://trustee.ietf.org/trust-legal-provisions.html). | ||
|
||
Any edit, commit, pull request, issue, comment or other change made to this | ||
repository constitutes Contributions to the IETF Standards Process | ||
(https://www.ietf.org/). | ||
|
||
You agree to comply with all applicable IETF policies and procedures, including, | ||
BCP 78, 79, the TLP, and the TLP rules regarding code components (e.g. being | ||
subject to a Simplified BSD License) in Contributions. | ||
|
||
|
||
## Mechanics | ||
|
||
Contributions can be made by creating pull requests. | ||
The GitHub interface supports creating pull requests using the Edit (✏) button. | ||
|
||
|
||
## Building the Specification | ||
|
||
The specification is written in | ||
[kramdown-rfc](https://github.com/cabo/kramdown-rfc/wiki/Syntax2), which | ||
compiles via [RFCXML](https://authors.ietf.org/rfcxml-vocabulary) to text and | ||
HTML. | ||
|
||
You can build the formatted versions or the intermediate RFCXML file using | ||
https://author-tools.ietf.org/ or locally by running `make`. To preserve the | ||
intermediate RFCXML form in a local build, `touch draft-marchan-kdl2.xml` before | ||
running `make`. | ||
|
||
Command line usage requires that you have the necessary software installed. See | ||
[the instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/SETUP.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
LIBDIR := lib | ||
include $(LIBDIR)/main.mk | ||
|
||
$(LIBDIR)/main.mk: | ||
ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null)) | ||
git submodule sync | ||
jyasskin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
git submodule update --init | ||
else | ||
ifneq (,$(wildcard $(ID_TEMPLATE_HOME))) | ||
ln -s "$(ID_TEMPLATE_HOME)" $(LIBDIR) | ||
else | ||
git clone -q --depth 10 -b main \ | ||
https://github.com/martinthomson/i-d-template $(LIBDIR) | ||
endif | ||
endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried this and I just got an error