sel4/website

The seL4.systems website

seL4 Website

The seL4.systems website is built on a templating engine based on PSP

It requires a python 3 mod_python for Apache2.

Docker

The directory docker/ provides a docker file and some scripts to host the website inside a container. It is also used for GitHub pull request checks and preview.

To use the docker container locally, install docker and run

cd docker
make

This will build the container (takes a while the first time), and then run it such that you can preview the website on port 8080 on your local machine.

Licences

Files in this repository (with a few exceptions) are released under standard open source licences, identified by SPDX Licence tags. See individual file headers for details.

As a general rule, code files are under GPL v2, and documents under the Creative Commons Licence CC-BY-SA (4.0 International) licence.

This repository also contains a copy of the Bootstrap CSS, which is licensed under the MIT Licence.

Some files contain representations of trademarks. Irrespective of any licence markings, logos and trademarks in this repository are owned by their respective owners. No licenses or other rights in or to such logos and/or trademarks are granted. The Trademark guidelines for the seL4 Foundation can be found at https://sel4.systems/Foundation/Trademark

Permission to use pictures of people have been granted for display on the seL4.systems website only. Please do not use them for any other purpose.

website's Issues

Website: consistent titles

(This may wait for the Information Architecture feedback first)

The titles on the landing page, top menu and individual pages should be made consistent. It's more confusing than it adds value to have them different.

For instance:

• "What is seL4" vs "About seL4" (I would keep the latter)
• "Stay in touch" vs "Contact information" (I would keep the former)
• "Commercial Support" vs "Services endorsed by the Foundation" (I would keep the former)
• "Use" vs "Retrofitting and transitioning to seL4" (I would revisit this page)
• "Support seL4" vs "Support us" vs "Funding the next big steps for the seL4 project" (I would keep the first)
• "Want to know more" vs "More information about seL4" (I would revisit and maybe merge with About seL4)

Docsite content: hardware: instructions if board not in the list

On https://docs.sel4.systems/Hardware/ we want to have instructions on what to do if the board you want is not in the list.

Website: clarify contact us?

In various pages we have a "contact us" link that goes to the general contact pages, that has all the various emails. Do we want to be more specific to which address to use for the topic where the "contact us" mention is?

Eg:

• in the "Use" / "Retrofitting and transitioning to seL4" we have "contact us" in many places (if want to use seL4, if want to extend what's supported in the roadmap etc)
• in "Contribute", we have "contact us" to discuss proof contributions

Other pages have the specific email, eg:

• in "TM": "please contact [email protected]"
• in "Join us": "Email us at [email protected]"

Provide an anchor for each news item, so one can refer to them by a specific URL

https://sel4.systems/news.pml has a lot of news items now, sometime a need arises to link a specific item from the past. There seems no way to create an URL for this. My current case is linking to "13 August 2021: seL4 protects world's most secure drone from DEFCON hackers" together with a link to the presentation video now available at https://youtu.be/X9rsv4YIShY (we could add the link at the news item now).

Creating a HTML anchor manually for each news item might be the most simple solution to solve this for now. Creating an linkable anchor seems easy, just give the div tag a unique id made form the date-stamp

<div id="20210813" class="news-item">
  13 August 2021: seL4 protects world's most secure drone from DEFCON hackers
</div>

And then https://sel4.systems/news.pml#20210813 can be used. However, there is no easy way to make this link public, the crude way would be embedding a relative link:

<div id="20210813" class="news-item">
  13 August 2021: <a href="#20210813">seL4 protects world's most secure drone from DEFCON hackers</a>
</div>

or with an anchor symbol:

<div id="20210813" class="news-item">
  <a href="#20210813">&#9875;</a>&nbsp;
  13 August 2021: seL4 protects world's most secure drone from DEFCON hackers
</div>

Links are indistinguishable from regular text

The link colour specified in the stylesheet is too dark, I can't easily tell where the links on a page are.

website/content/css/sel4.css

Line 6 in 2e3e4ea

color: #385378 /* neutral */

Docsite content: update Supported Platforms page

Update the https://docs.sel4.systems/Hardware/ page to make sure it's consistent, up to date, and with an easy high-level take-away for a wider audience.

• add an exec summary at the very top: x86, ARM, RISC-V; maybe also saying whether it's 32 and 64 bits; maybe be clear about the situation for MCS / multicore; maybe linked from seL4 main website?
• add link to the "verified configurations" page
• make things consistent across the page / other pages
  • IOMMU vs SMMU vs System MMU
  • the RISC-V table header should be bold and grey
  • "in progress" vs "pending" for the verification status
  • ARM HYP vs ARM Hyp
  • "status" in the table should be "verification status" to be clearer
• for verification status: do we ignore SysInit? BV?
• what is the "pending" Ariane RISC-V?

Figure out way for PRs from forks to work with static site generator

Relating to: #20

A possible solution is to switch back to pull_request_target, and do something like suggested here: #20 (comment) - that is, figure out what the real PR SHA is, and check that out manually.

The real issue is that forks can't see any github.SECRETS, which means the 'deploy the generated site to a git repo' doesn't work, and so we need a work around.

can't check out repo on Mac

There are some files that become identical under case-insensitive file systems, content/js/tinymce/LICENSE.TXT and content/js/tinymce/license.txt

git clone [email protected]:seL4/website.git
Cloning into 'website'...
remote: Enumerating objects: 391, done.
remote: Counting objects: 100% (391/391), done.
remote: Compressing objects: 100% (296/296), done.
remote: Total 391 (delta 28), reused 391 (delta 28), pack-reused 0
Receiving objects: 100% (391/391), 19.91 MiB | 1.29 MiB/s, done.
Resolving deltas: 100% (28/28), done.
warning: the following paths have collided (e.g. case-sensitive paths
on a case-insensitive filesystem) and only one from the same
colliding group is in the working tree:

  'content/js/tinymce/LICENSE.TXT'
  'content/js/tinymce/license.txt'

Better link between website and docsite (and github)

(This may wait for the Information Architecture feedback first)

The links between the seL4 website and the docsite (and github) should be improved.

Currently:

• finding a link to the docsite from the website is difficult. It should be obvious. And it should be obvious that both co-exist
• we need to think which important pages form docsite should be made visible and easily found on the website (e.g. FAQ, roadmap, projects...)
• some topic overlap should be discuss, eg
  • TSC is on the website, roles description is on the docsite
  • Learn and Contribute have a landing pages on the website, with various links to the docsite; we should think how much information should be on both, or docsite should link back to website.

seL4 benchmarking 'Performance' page is broken

Navigating to the http://sel4.systems/About/Performance/ results in the following error message

Content Encoding Error
The page you are trying to view cannot be shown because it uses an invalid or unsupported form of compression.
Please contact the web site owners to inform them of this problem.

Show history graphs on performance page

Now that the performance page is updated regularly, it would be nice to have a graph available that shows the history of each value and link to the commit that was used to build the images that produces these.

Add news item about latest seL4 release

Add news item that there is a new release with seL4 12.1, CAmkES 3.10 and CapDL 0.2.1

Website: jobs page is outdated

(This may wait for the Information Architecture feedback first)

The Jobs page should:

• be revisited, updated
• be taken out of the Foundation's substructure (#304)
• appear somewhere in the top menu / landing page (#305)

Develop GitHub workflow to allow easy review of PRs

We need to enable github workflows that will allow contributors and reviewers to be able to easily view the changes they would like to make to the seL4 website.

Things to do:

• Create a Dockerfile that can setup Apache to work with the seL4 website, and host it successfully. #1
• Get the GitHub workflow to override the /var/www/seL4 dir within the container with whatever the PR state is.
• Use wget to snapshot the website from the locally run server
• Commit the files to another repo
• Make a link using the htmlpreview service, and comment it on to the PR
• Clean up the gross bits

RSS/atom feed for https://sel4.systems/news.pml.html

Having a RSS/atom feed for the ticker at https://sel4.systems/news.pml.html would be a nice-to-have.

Support RSS/atom feed for news

There should be an RSS/atom feed for news, this allows monitoring automation then.

Website: top menu should be reordered and restructured

(This may wait for the Information Architecture feedback first)

The top menu should be

• consistent with landing page in naming
• ordered the same way than the landing page

We should also revisit it once the new information architecture is set (including if we move some pages out of the Foundation's substructure #304)

News item anchors should be visible when hovering over an issue

... so you don't have to read the source each time you want to reference an item

Website: restructure the Foundation substructure

(This may wait for the Information Architecture feedback first)

• The Foundation substructure should only keep these pages: About, Governance (see point below), Governing board, TSC, Membership and Join.

• I would merge the Governance page into the About one; I would remove the "key principles" document (outdated), just keep the Principles paragraph and have a "Two Foundation bodies" paragraph pointing to the Governing Board and the TSC (adding the currently missing link to the TSC page). I would update the About page, removing old info like the original press release.

• The following other pages aren't specific to the Foundation and already appear on the main landing page: Summit, TM, Support seL4 / Funding the next big steps..., Commercial support / Endorses providers. I would therefore just remove them from under the Foundation, but we need to revisit the top menu bar do have them appear somewhere (#305).

• The following 2 pages only appear under the Foundation: Jobs and Contact the Foundation. The Contact page should be removed and link to the general "Stay in touch" page. The Jobs page is out of date and should be revisited (#306)

https://sel4.systems/Info/FAQ/proof.pml page doesn't talk about RISC-V

Under "What we prove":
" The binary code of the ARM version of the seL4 microkernel correctly implements the behaviour described in its abstract specification and nothing more. Furthermore, the specification and the seL4 binary satisfy the classic security properties called integrity and confidentiality. "

Website: revisit the "More information" page

(This may wait for the Information Architecture feedback first)

• Is it still appropriate to have the "Research" tab only going to TS? (other people in the community do research on seL4) and is that TS research page still up to date?

• Could we merge this "More information" into the "About seL4" page?

• The FAQ and Roadmap are linked to the docsite, which are part of thinking how to link better the 2 sites (#309)