Skip to content

Commit

Permalink
Editorial: update the standard for the WHATWG move
Browse files Browse the repository at this point in the history
* Update repository files using whatwg/spec-factory.
* Use the WHATWG template.
* Add an Acknowledgments section and IPR statement.
* Sentence-case all headings.
* Add missing example IDs.
* Fix some markup in the introductory example to work well with WHATWG styling.
* Fix some invalid HTML, double-"the" typos, and usage of "and/or" disallowed by the linter.
* Reword some disallowed uses of RFC 2119 keywords, and mark up some uses of "optional" as allowed.

Part of #190. See also whatwg/sg#215.
  • Loading branch information
domenic authored Oct 20, 2023
1 parent 9504c41 commit dabcf9f
Show file tree
Hide file tree
Showing 17 changed files with 632 additions and 223 deletions.
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ charset = utf-8
indent_size = 2
indent_style = space
trim_trailing_whitespace = true
max_line_length = 100

[Makefile]
indent_style = tab

[*.bs]
indent_size = 2
max_line_length = off

[*.py]
indent_size = 4
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/0-new-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: New issue
description: File a new issue against the URL Pattern Standard.
body:
- type: markdown
attributes:
value: |
Before filling out this form, please familiarize yourself with the [Code of Conduct](https://whatwg.org/code-of-conduct). You might also find the [FAQ](https://whatwg.org/faq) and [Working Mode](https://whatwg.org/working-mode) useful.
If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
- type: textarea
attributes:
label: "What is the issue with the URL Pattern Standard?"
validations:
required: true
- type: markdown
attributes:
value: "Thank you for taking the time to improve the URL Pattern Standard!"
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/1-new-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: New feature
description: Request a new feature in the URL Pattern Standard.
labels: ["addition/proposal", "needs implementer interest"]
body:
- type: markdown
attributes:
value: |
Before filling out this form, please familiarize yourself with the [Code of Conduct](https://whatwg.org/code-of-conduct), [FAQ](https://whatwg.org/faq), and [Working Mode](https://whatwg.org/working-mode). They help with setting expectations and making sure you know what is required. The FAQ ["How should I go about proposing new features to WHATWG standards?"](https://whatwg.org/faq#adding-new-features) is especially relevant.
If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
- type: textarea
attributes:
label: "What problem are you trying to solve?"
validations:
required: true
- type: textarea
attributes:
label: "What solutions exist today?"
- type: textarea
attributes:
label: "How would you solve it?"
- type: textarea
attributes:
label: "Anything else?"
- type: markdown
attributes:
value: "Thank you for taking the time to improve the URL Pattern Standard!"
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Chat
url: https://whatwg.org/chat
about: Please do reach out with questions and feedback!
- name: Stack Overflow
url: https://stackoverflow.com/
about: If you're having trouble building a web page, this is not the right repository. Consider asking your question on Stack Overflow instead.
21 changes: 12 additions & 9 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,17 @@ on:
jobs:
build:
name: Build
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v2
- name: Build
run: make ci
- name: Deploy
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
uses: peaceiris/actions-gh-pages@v3
- uses: actions/checkout@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./out
fetch-depth: 2
- uses: actions/setup-python@v4
with:
python-version: "3.11"
# Note: `make deploy` will do a deploy dry run on PRs.
- run: make deploy
env:
SERVER: ${{ secrets.MARQUEE_SERVER }}
SERVER_PUBLIC_KEY: ${{ secrets.MARQUEE_PUBLIC_KEY }}
SERVER_DEPLOY_KEY: ${{ secrets.MARQUEE_DEPLOY_KEY }}
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/out/
/urlpattern.spec.whatwg.org/
/deploy.sh
/spec.html
*.swp
7 changes: 6 additions & 1 deletion .pr-preview.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
{
"src_file": "spec.bs",
"type": "bikeshed"
"type": "bikeshed",
"params": {
"force": 1,
"md-status": "LS-PR",
"md-Text-Macro": "PR-NUMBER {{ pull_request.number }}"
}
}
3 changes: 0 additions & 3 deletions CODE_OF_CONDUCT.md

This file was deleted.

26 changes: 0 additions & 26 deletions CONTRIBUTING.md

This file was deleted.

Loading

0 comments on commit dabcf9f

Please sign in to comment.