diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..bd1e77c --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,101 @@ +version: 2 +jobs: + build: + docker: + - image: martinthomson/i-d-template:latest + resource_class: small + working_directory: ~/draft + + steps: + - run: + name: "Print Configuration" + command: | + xml2rfc --version + gem list -q kramdown-rfc + echo -n 'mmark '; mmark --version + + - restore_cache: + name: "Restoring cache - Git" + keys: + - v2-cache-git-{{ .Branch }}-{{ .Revision }} + - v2-cache-git-{{ .Branch }} + - v2-cache-git- + + - restore_cache: + name: "Restoring cache - References" + keys: + - v1-cache-references-{{ epoch }} + - v1-cache-references- + + # Workaround for https://discuss.circleci.com/t/22437 + - run: + name: Tag Checkout + command: | + if [ -n "$CIRCLE_TAG" ] && [ -d .git ]; then + remote=$(echo "$CIRCLE_REPOSITORY_URL" | \ + sed -e 's,/^git.github.com:,https://github.com/,') + git fetch -f "$remote" "refs/tags/$CIRCLE_TAG:refs/tags/$CIRCLE_TAG" || \ + (echo 'Removing .git cache for tag build'; rm -rf .git) + fi + + - checkout + + # Build txt and html versions of drafts + - run: + name: "Build Drafts" + command: make + + # Update editor's copy on gh-pages + - run: + name: "Update GitHub Pages" + command: | + if [ "${CIRCLE_TAG#draft-}" == "$CIRCLE_TAG" ]; then + make gh-pages + fi + + # For tagged builds, upload to the datatracker. + - deploy: + name: "Upload to Datatracker" + command: | + if [ "${CIRCLE_TAG#draft-}" != "$CIRCLE_TAG" ]; then + make upload + fi + + # Archive GitHub Issues + - run: + name: "Archive GitHub Issues" + command: "make archive || make archive DISABLE_ARCHIVE_FETCH=true && make gh-archive" + + # Create and store artifacts + - run: + name: "Create Artifacts" + command: "make artifacts CI_ARTIFACTS=/tmp/artifacts" + + - store_artifacts: + path: /tmp/artifacts + + - run: + name: "Prepare for Caching" + command: "git reflog expire --expire=now --all && git gc --prune=now" + + - save_cache: + name: "Saving Cache - Git" + key: v2-cache-git-{{ .Branch }}-{{ .Revision }} + paths: + - ~/draft/.git + + - save_cache: + name: "Saving Cache - Drafts" + key: v1-cache-references-{{ epoch }} + paths: + - ~/.cache/xml2rfc + + +workflows: + version: 2 + build: + jobs: + - build: + filters: + tags: + only: /.*?/ diff --git a/LICENSE.md b/LICENSE.md index abd2c02..2a453bd 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,19 +1,4 @@ # License -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 the 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](https://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.rfc-editor.org/info/bcp9). - -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 Revised BSD License) in -Contributions. +See the +[guidelines for contributions](https://github.com/{GITHUB_USER}/{GITHUB_REPO}/blob/{GITHUB_BRANCH}/CONTRIBUTING.md). diff --git a/Makefile b/Makefile index de46d56..b8ed73a 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,4 @@ +TEXT_PAGINATION := true LIBDIR := lib include $(LIBDIR)/main.mk diff --git a/draft-ietf-core-coap-pubsub.md b/draft-ietf-core-coap-pubsub.md index 3e7fef9..6dd8f09 100644 --- a/draft-ietf-core-coap-pubsub.md +++ b/draft-ietf-core-coap-pubsub.md @@ -128,18 +128,18 @@ The broker is responsible for the store-and-forward of state update representati ~~~~ aasvg CoAP CoAP CoAP clients server clients - .-----------. .----------. observe .-----------. - | | publish | |<----------+ | - | publisher +--------->+ +---------->| subscribe | - | | | +---------->| | - '-----------' | | '-----------' + .-----------. .----------. observe .------------. + | | publish | |<----------+ | + | publisher +--------->+ +---------->| subscriber | + | | | +---------->| | + '-----------' | | '------------' ... | broker | ... ... | | ... - .-----------. | | observe .-----------. - | | publish | |<----------+ | - | publisher +--------->| +---------->| subscribe | - | | | +---------->| | - '-----------' '----------' '-----------' + .-----------. | | observe .------------. + | | publish | |<----------+ | + | publisher +--------->| +---------->| subscriber | + | | | +---------->| | + '-----------' '----------' '------------' ~~~~ {: #fig-arch title='Publish-subscribe architecture over CoAP' artwork-align="center"} @@ -593,7 +593,7 @@ On success, the server returns a 2.04 (Changed) response and the current full re As with the PUT method, updating the "topic-data" path will automatically cancel all existing observations on it and thus will unsubscribe all subscribers. Decreasing max-subscribers will also cause some subscribers to get unsubscribed. Unsubscribed endpoints SHOULD receive a final 4.04 (Not Found) response as per {{!RFC7641}} Section 3.2. -Contrary to PUT iPATCH operations will explicitly update some parameters, leaving others unmodified. +Contrary to PUT, iPATCH operations will explicitly update some parameters, leaving others unmodified. ~~~~ => 0.07 iPATCH @@ -621,9 +621,7 @@ Contrary to PUT iPATCH operations will explicitly update some parameters, leavin } ~~~~ -Note that when a topic configuration changes through an iPATCH request, it may result in disruptions for the subscribers. Some potential issues that may arise include: - -Limiting the number of subscribers will cause to cancel ongoing subscriptions until max-subscribers has been reached. +Note that when a topic configuration changes through an iPATCH request, it may result in disruptions for the subscribers. For example, limiting the number of subscribers will cause to cancel ongoing subscriptions until max-subscribers has been reached. ### Deleting a topic-configuration {#topic-delete}