From 844da423009d5e3774d7196efb1a6da6e897c4bd Mon Sep 17 00:00:00 2001 From: Frederik Ring Date: Thu, 1 Apr 2021 17:10:29 +0200 Subject: [PATCH] adjust setup inherited from template --- .circleci/config.yml | 100 ---------------------------------- .github/workflows/archive.yml | 32 ----------- .github/workflows/publish.yml | 49 ----------------- .note.xml | 3 - README.md | 6 +- draft-offen-analyticstxt.md | 71 ++++++++++++------------ 6 files changed, 38 insertions(+), 223 deletions(-) delete mode 100644 .circleci/config.yml delete mode 100644 .github/workflows/archive.yml delete mode 100644 .github/workflows/publish.yml diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 192e849..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,100 +0,0 @@ -version: 2 -jobs: - build: - docker: - - image: martinthomson/i-d-template:latest - working_directory: ~/draft - - steps: - - run: - name: "Print Configuration" - command: | - xml2rfc --version - gem list -q kramdown-rfc2629 - 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 'CLONE_ARGS=--reference ~/git-reference'" - - # 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/.github/workflows/archive.yml b/.github/workflows/archive.yml deleted file mode 100644 index fb0e0d1..0000000 --- a/.github/workflows/archive.yml +++ /dev/null @@ -1,32 +0,0 @@ -name: "Archive Issues and Pull Requests" - -on: - schedule: - - cron: '0 0 * * 0,2,4' - repository_dispatch: - types: [archive] - -jobs: - build: - name: "Archive Issues and Pull Requests" - runs-on: ubuntu-latest - steps: - - name: "Checkout" - uses: actions/checkout@v2 - - - name: "Update Archive" - uses: martinthomson/i-d-template@v1 - with: - make: archive - token: ${{ secrets.GITHUB_TOKEN }} - - - name: "Update GitHub Pages" - uses: martinthomson/i-d-template@v1 - with: - make: gh-archive - token: ${{ secrets.GITHUB_TOKEN }} - - - name: "Save Archive" - uses: actions/upload-artifact@v2 - with: - path: archive.json diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml deleted file mode 100644 index f9dbcab..0000000 --- a/.github/workflows/publish.yml +++ /dev/null @@ -1,49 +0,0 @@ -name: "Publish New Draft Version" - -on: - push: - tags: - - "draft-*" - -jobs: - build: - name: "Publish New Draft Version" - runs-on: ubuntu-latest - steps: - - name: "Checkout" - uses: actions/checkout@v2 - - # See https://github.com/actions/checkout/issues/290 - - name: "Get Tag Annotations" - run: git fetch -f origin ${{ github.ref }}:${{ github.ref }} - - - name: "Cache Setup" - id: cache-setup - run: | - mkdir -p "$HOME"/.cache/xml2rfc - echo "::set-output name=path::$HOME/.cache/xml2rfc" - date -u "+::set-output name=date::%FT%T" - - - name: "Cache References" - uses: actions/cache@v2 - with: - path: | - ${{ steps.cache-setup.outputs.path }} - .targets.mk - key: refcache-${{ steps.date.outputs.date }} - restore-keys: | - refcache-${{ steps.date.outputs.date }} - refcache- - - - name: "Build Drafts" - uses: martinthomson/i-d-template@v1 - - - name: "Upload to Datatracker" - uses: martinthomson/i-d-template@v1 - with: - make: upload - - - name: "Archive Submitted Drafts" - uses: actions/upload-artifact@v2 - with: - path: "draft-*-[0-9][0-9].xml" diff --git a/.note.xml b/.note.xml index d64f36b..397d9fc 100644 --- a/.note.xml +++ b/.note.xml @@ -1,7 +1,4 @@ -Discussion of this document takes place on the - mailing list (analyticstxt@ietf.org), - which is archived at . Source for this draft and an issue tracker can be found at . diff --git a/README.md b/README.md index a7c6f89..830e360 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# A proposed standard which allows websites and services to disclose information about their usage of analytics software and user tracking. +# analytics.txt + +## A proposed standard which allows websites and services to disclose information about their usage of analytics software and user tracking. This is the working area for the individual Internet-Draft, "A proposed standard which allows websites and services to disclose information about their usage of analytics software and user tracking.". * [Editor's Copy](https://offen.github.io/analyticstxt/#go.draft-offen-analyticstxt.html) -* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-offen-analyticstxt) -* [Compare Editor's Copy to Individual Draft](https://offen.github.io/analyticstxt/#go.draft-offen-analyticstxt.diff) ## Building the Draft diff --git a/draft-offen-analyticstxt.md b/draft-offen-analyticstxt.md index c7d6a6f..f9687a2 100644 --- a/draft-offen-analyticstxt.md +++ b/draft-offen-analyticstxt.md @@ -93,9 +93,9 @@ The content of the comment may contain any ASCII or Unicode characters in the %x Example: -``` +~~~~~~~~~~ # A comment -``` +~~~~~~~~~~ Implementors SHOULD make deliberate use of comments to make an analytics.txt file more accessible for non-technical audiences. @@ -122,9 +122,9 @@ The field MUST contain a valid email address which shall be used for inquiries a #### Example -``` +~~~~~~~~~~ Contact: Jane Doe -``` +~~~~~~~~~~ ### Collects {#collects-field} @@ -180,9 +180,9 @@ Detailed behavior like mouse movement and scrolling is recorded and can possibly #### Example -``` +~~~~~~~~~~ Collects: url, device-type, referrer -``` +~~~~~~~~~~ ### Stores @@ -216,9 +216,9 @@ No data is persisted on the client during the collection of usage data. #### Example -``` +~~~~~~~~~~ Stores: 1st-party-cookies, local-storage -``` +~~~~~~~~~~ ### Uses @@ -249,9 +249,9 @@ Other techniques that are not described in this section are in use. #### Example -``` +~~~~~~~~~~ Uses: script -``` +~~~~~~~~~~ ### Allows @@ -275,23 +275,23 @@ The software does not define a way for users to opt in or opt out of the collect #### Example -``` +~~~~~~~~~~ Allows: opt-in, opt-out -``` +~~~~~~~~~~ ### Retains This field is REQUIRED unless the only value of Collects is none. The single-value field indicates the duration for which the analytics data is being stored before being delete. -The value is a duration as defined in {{!RFC 3339}}. +The value is a duration as defined in {{!RFC3339}}. Implementors SHOULD add a comment providing a human readable value to this field. #### Example -``` +~~~~~~~~~~ # Data is retained for twelve months Retains: P12M -``` +~~~~~~~~~~ ### Session @@ -314,9 +314,9 @@ A user can be identified across multiple browser sessions. #### Example -``` +~~~~~~~~~~ Session: user -``` +~~~~~~~~~~ ### Variants @@ -339,9 +339,9 @@ Content experiments are performed by grouping users into buckets based on their #### Example -``` +~~~~~~~~~~ Variants: random -``` +~~~~~~~~~~ ### Visibility @@ -359,9 +359,9 @@ Usage statistics for the site or service are available to the general public. #### Example -``` +~~~~~~~~~~ Visibility: public -``` +~~~~~~~~~~ ### Compliance @@ -375,9 +375,9 @@ Example values are: #### Example -``` +~~~~~~~~~~ Compliance: gdpr, ccpa -``` +~~~~~~~~~~ ### Vendors @@ -393,16 +393,15 @@ Example values are: #### Example -``` +~~~~~~~~~~ Vendors: offen, hotjar -``` +~~~~~~~~~~ ## Examples of analytics.txt files -### Example of a site with analytics +Example of a site with analytics: -``` -# analytics.txt file for https://www.analyticstxt.org +~~~~~~~~~~ Author: Frederik Ring Collects: url, referrer, device-type @@ -419,15 +418,15 @@ Session: user Variants: none Visibility: user Compliance: gdpr -``` +~~~~~~~~~~ -### Example of a site not using any analytics +Example of a site not using any analytics: -``` +~~~~~~~~~~ # analytics.txt file for https://www.frederikring.com Author: Frederik Ring Collects: none -``` +~~~~~~~~~~ # Location of the analytics.txt file {#location} @@ -443,9 +442,9 @@ Implementors MAY signal the location of an analytics.txt file in the context of Example: -```html +~~~~~~~~~~ -``` +~~~~~~~~~~ ### HTTP Header @@ -453,9 +452,9 @@ In addition to that implementors MAY send an HTTP header of `X-Analytics-Txt` wi Example: -``` +~~~~~~~~~~ X-Analytics-Txt: https://example.com/resources/analytics.txt -``` +~~~~~~~~~~ ## Precendence