diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8682023 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +# See http://editorconfig.org + +root = true + +[*.{md,xml,org}] +charset = utf-8 +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..8fab23b --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Automatically generated CODEOWNERS +# Regenerate with `make update-codeowners` +draft-todo-yourname-protocol.md tim@blackdogradio.com diff --git a/.github/workflows/setup.yml b/.github/workflows/setup.yml deleted file mode 100644 index 60445f8..0000000 --- a/.github/workflows/setup.yml +++ /dev/null @@ -1,99 +0,0 @@ -name: "Perform Initial Repository Setup" - -on: - push: - branches: [main] - -jobs: - setup: - name: "Setup Repository" - runs-on: ubuntu-latest - steps: - - name: "Checkout" - uses: actions/checkout@v4 - - - name: "Precondition Check" - id: pre - run: | - if ! ls draft-* rfc* 2>/dev/null | grep -qv draft-todo-yourname-protocol.md; then - echo "=============================================================" - echo "Skipping setup for the first commit." - echo - echo "Rename draft-todo-yourname-protocol.md to start using this repository:" - echo - echo " https://github.com/${{github.repository}}/edit/main/draft-todo-yourname-protocol.md" - echo - echo "Change the name of the file and its title." - echo "Commit the changes to the 'main' branch." - echo - echo "=============================================================" - echo "skip=true" >>"$GITHUB_OUTPUT" - elif [ ! -f draft-todo-yourname-protocol.md -a -f Makefile ]; then - echo "=============================================================" - echo "Skipping setup for an already-configured repository." - echo - echo "Delete .github/workflows/setup.yml to avoid running this action:" - echo - echo " https://github.com/${{github.repository}}/delete/main/.github/workflows/setup.yml" - echo - echo "=============================================================" - echo "skip=true" >>"$GITHUB_OUTPUT" - fi - - - name: "Git Config" - if: ${{ steps.pre.outputs.skip != 'true' }} - run: | - git config user.email "idbot@example.com" - git config user.name "I-D Bot" - - - name: "Update Draft Name" - if: ${{ steps.pre.outputs.skip != 'true' }} - run: | - for i in draft-*; do - if [ "$(head -1 "$i")" = "---" ]; then - sed -i -e '2,/^---/{/^###/,/^###/d - s|^docname: .*|docname: '"${i%.md}-latest"'| - s|^ fullname: Your Name Here| fullname: "'"$(git show -q --format='format:%aN' @)"'"| - s|^ email: your\.email@example\.com| email: "'"$(git show -q --format='format:%aE' @)"'"| - }' "$i" - fi - sed -i -e "s/draft-todo-yourname-protocol-latest/${i%.md}-latest/g" "$i" - git add "$i" - done - if [ -n "$(git status --porcelain draft-*)" ]; then - git commit -m "Update draft labels" draft-* - fi - - - name: "Cleanup" - if: ${{ steps.pre.outputs.skip != 'true' }} - run: | - git rm -rf .github/workflows/setup.yml README.md - git commit -m "Remove setup files" - - - name: "Clone the i-d-template Repo" - if: ${{ steps.pre.outputs.skip != 'true' }} - run: | - git clone --depth=1 https://github.com/martinthomson/i-d-template lib - - - name: "Run i-d-template Setup" - if: ${{ steps.pre.outputs.skip != 'true' }} - uses: martinthomson/i-d-template@v1 - with: - make: setup - - - name: "Update Venue Information" - if: ${{ steps.pre.outputs.skip != 'true' }} - uses: martinthomson/i-d-template@v1 - with: - make: update-venue - - - name: "Update GitHub Pages" - if: ${{ steps.pre.outputs.skip != 'true' }} - uses: martinthomson/i-d-template@v1 - with: - make: gh-pages - - - name: "Push Changes" - if: ${{ steps.pre.outputs.skip != 'true' }} - run: | - git push diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..64c786d --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +*.html +*.pdf +*.redxml +*.swp +*.txt +*.upload +*~ +.tags +/*-[0-9][0-9].xml +/.gems/ +/.refcache +/.targets.mk +/.venv/ +/.vscode/ +/lib +/node_modules/ +/versioned/ +Gemfile.lock +archive.json +draft-todo-yourname-protocol.xml +package-lock.json +report.xml +!requirements.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..950e482 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# 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. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..db6ddc5 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,4 @@ +# License + +See the +[guidelines for contributions](https://github.com/moonshiner/draft-wirelela-deleg-requirements/blob/main/CONTRIBUTING.md). diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..de46d56 --- /dev/null +++ b/Makefile @@ -0,0 +1,11 @@ +LIBDIR := lib +include $(LIBDIR)/main.mk + +$(LIBDIR)/main.mk: +ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null)) + git submodule sync + git submodule update $(CLONE_ARGS) --init +else + git clone -q --depth 10 $(CLONE_ARGS) \ + -b main https://github.com/martinthomson/i-d-template $(LIBDIR) +endif diff --git a/README.md b/README.md index 2583c57..1c6a1ff 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,30 @@ -# Internet-Draft Template Repository +# TODO - Your title -Use this repository as a template if you want to start working on -[IETF](https://www.ietf.org/) documents. [Click here to create a new repository using the -template](https://github.com/martinthomson/internet-draft-template/generate). -Make sure to check "Include all branches", or you will need to enable GitHub Pages manually. +This is the working area for the individual Internet-Draft, "TODO - Your title". -[Read the -instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/TEMPLATE.md) -for more information. +* [Editor's Copy](https://moonshiner.github.io/draft-wirelela-deleg-requirements/#go.draft-todo-yourname-protocol.html) +* [Datatracker Page](https://datatracker.ietf.org/doc/draft-todo-yourname-protocol) +* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-todo-yourname-protocol) +* [Compare Editor's Copy to Individual Draft](https://moonshiner.github.io/draft-wirelela-deleg-requirements/#go.draft-todo-yourname-protocol.diff) -Once you have created your own repository, start work by: -1. Set "Workflow permissions" to "Read and write permissions" - [in the repository settings](../../settings/actions#actions_default_workflow_permissions_write). +## Contributing + +See the +[guidelines for contributions](https://github.com/moonshiner/draft-wirelela-deleg-requirements/blob/main/CONTRIBUTING.md). + +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`. + +```sh +$ 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). -2. Rename the `draft-todo-yourname-protocol.md` file - [here](../../edit/main/draft-todo-yourname-protocol.md).