Skip to content
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

Update wmas2018 runner #85

Draft
wants to merge 3 commits into
base: wmas2018
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 4 additions & 6 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
_site
.sass-cache
.jekyll-metadata
.bundle/
Gemfile.lock
vendor/bundle/
_build/

# This directory is created to store symbolic links to additional input
tools/
23 changes: 23 additions & 0 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
FROM ubuntu:20.04

# No interactive frontend during docker build
ENV DEBIAN_FRONTEND=noninteractive \
DEBCONF_NONINTERACTIVE_SEEN=true

RUN apt-get -qqy update \
&& apt-get -qqy install git npm python3 python3-venv

WORKDIR /app/

COPY package.json requirements.txt ./

RUN npm install .
ENV PATH=/app/node_modules/.bin:$PATH

# Use venv to create a virtual environment with the docs dependencies installed,
# setting the environment variables needed for this to always be active. The
# `./wpt build-docs` then uses this venv with --skip-venv-setup.
ENV VIRTUAL_ENV=/app/venv
RUN python3 -m venv $VIRTUAL_ENV
ENV PATH=$VIRTUAL_ENV/bin:$PATH
RUN pip install -r requirements.txt
2 changes: 0 additions & 2 deletions docs/META.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
suggested_reviewers:
- sideshowbarker
- dontcallmedom
- gsnedders
24 changes: 24 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Project documentation tooling

The documentation for the web-platform-tests project is built using [the Sphinx
documentation generator](http://www.sphinx-doc.org). [The GitHub Actions
service](https://github.com/features/actions) is configured to automatically
update the public website each time changes are merged to the repository.

## Local Development

If you would like to build the site locally, follow these instructions.

1. Install the system dependencies. The free and open source software tools
[Python](https://www.python.org/) and [Git](https://git-scm.com/) are
required. Each website has instructions for downloading and installing on a
variety of systems.
2. Download the source code. Clone this repository using the `git clone`
command.
3. Install the Python dependencies. Run the following command in a terminal
from the "docs" directory of the WPT repository:

pip install -r requirements.txt

4. Build the documentation. Windows users should execute the `make.bat` batch
file. GNU/Linux and macOS users should use the `make` command.
Empty file added docs/__init__.py
Empty file.
103 changes: 103 additions & 0 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Project Administration

This section documents all the information necessary to administer the
infrastructure which makes the project possible.

## Tooling

```eval_rst
.. toctree::
:titlesonly:

../README
/tools/wptrunner/README.rst
/tools/wptserve/docs/index.rst
pywebsocket3

.. toctree::
:hidden:

../tools/wptserve/README
../tools/third_party/pywebsocket3/README
```

### Indices and tables

```eval_rst
* :ref:`modindex`
* :ref:`genindex`
* :ref:`search`
```

## Secrets

SSL certificates for all HTTPS-enabled domains are retrieved via [Let's
Encrypt](https://letsencrypt.org/), so that data does not represent an
explicitly-managed secret.

## Third-party account owners

- (unknown registrar): https://web-platform-tests.org
- [email protected]
- (unknown registrar): https://w3c-test.org
- [email protected]
- (unknown registrar): http://testthewebforward.org
- [email protected]
- [Google Domains](https://domains.google/): https://wpt.fyi
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- [GitHub](https://github.com/): web-platform-tests
- [@foolip](https://github.com/foolip)
- [@jgraham](https://github.com/jgraham)
- [@plehegar](https://github.com/plehegar)
- [@thejohnjansen](https://github.com/thejohnjansen)
- [@youennf](https://github.com/youennf)
- [@zcorpan](https://github.com/zcorpan)
- [GitHub](https://github.com/): w3c
- [@plehegar](https://github.com/plehegar)
- [@sideshowbarker](https://github.com/sideshowbarker)
- [Google Cloud Platform](https://cloud.google.com/): wptdashboard{-staging}
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- [Google Cloud Platform](https://cloud.google.com/): wpt-live
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- The DNS for wpt.live, not-wpt.live, wptpr.live, and not-wptpr.live are also managed in this project, while the domains are registered with a Google-internal mechanism.
- [Google Cloud Platform](https://cloud.google.com/): wpt-pr-bot
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- E-mail address: [email protected]
- [email protected]
- [email protected]
- [email protected]
- [GitHub](https://github.com/): @wpt-pr-bot account
- [email protected]
- [email protected]
- [email protected]

## Emergency playbook

### Lock down write access to the repo

**Recommended but not yet verified approach:** Create a [new branch protection
rule](https://github.com/web-platform-tests/wpt/settings/branch_protection_rules/new)
that applies to `*` (i.e. all branches), and check "Restrict who can push to
matching branches". This should prevent everyone except those with the
"Maintain" role (currently only the GitHub admins listed above) from pushing
to *any* branch. To lift the limit, delete this branch protection rule.

**Alternative approach proven to work in
[#21424](https://github.com/web-platform-tests/wpt/issues/21424):** Go to
[manage access](https://github.com/web-platform-tests/wpt/settings/access),
and change the permission of "reviewers" to "Read". To lift the limit, change
it back to "Write". This has the known downside of *resubscribing all reviewers
to repo notifications*.
91 changes: 91 additions & 0 deletions docs/admin/pywebsocket3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
pywebsocket3: A Standalone WebSocket Server for testing purposes
================================================================

.. contents::
:local:

:mod:`mod_pywebsocket`
---------------------------------------------

.. automodule:: mod_pywebsocket
:members:

:mod:`mod_pywebsocket.common`
---------------------------------------------

.. automodule:: mod_pywebsocket.common
:members:

:mod:`mod_pywebsocket.dispatch`
---------------------------------------------

.. automodule:: mod_pywebsocket.dispatch
:members:

:mod:`mod_pywebsocket.extensions`
---------------------------------------------

.. automodule:: mod_pywebsocket.extensions
:members:

:mod:`mod_pywebsocket.handshake`
---------------------------------------------

.. automodule:: mod_pywebsocket.handshake
:members:
:imported-members:

:mod:`mod_pywebsocket.request_handler`
---------------------------------------------

.. automodule:: mod_pywebsocket.request_handler
:members:

:mod:`mod_pywebsocket.stream`
---------------------------------------------

.. automodule:: mod_pywebsocket.stream
:members:
:imported-members:

:mod:`mod_pywebsocket.http_header_util`
---------------------------------------------

.. automodule:: mod_pywebsocket.http_header_util
:members:

:mod:`mod_pywebsocket.msgutil`
---------------------------------------------

.. automodule:: mod_pywebsocket.msgutil
:members:

:mod:`mod_pywebsocket.util`
---------------------------------------------

.. automodule:: mod_pywebsocket.util
:members:

:mod:`mod_pywebsocket.memorizingfile`
---------------------------------------------

.. automodule:: mod_pywebsocket.memorizingfile
:members:

:mod:`mod_pywebsocket.websocket_server`
---------------------------------------------

.. automodule:: mod_pywebsocket.websocket_server
:members:

:mod:`mod_pywebsocket.server_util`
---------------------------------------------

.. automodule:: mod_pywebsocket.server_util
:members:

:mod:`mod_pywebsocket.standalone`
---------------------------------------------

.. automodule:: mod_pywebsocket.standalone
:members:
Binary file modified docs/assets/createpr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/assets/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
div.body {
min-width: auto;
}

#video-introduction-transcript iframe {
max-width: 100%;
}

.table-container {
overflow: auto;
}
Binary file modified docs/assets/pullrequestbtn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/web-platform.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/commands.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"build-docs": {
"path": "frontend.py",
"parser": "get_parser",
"script": "build",
"help": "Build documentation",
"virtualenv": true,
"requirements": [
"requirements.txt"
]
}
}
Loading