Uptane Deployment Considerations website
The site is available here.
This repository is a dedicated place for the deployment considerations text. Whatever is on master will be built automatically by github, and deployed at https://uptane.github.io/deployment-considerations.
Maintenance and re-use
GitHub pages are served directly from the repository. No pre-building necessary.
For development deployment, we recommend the following commands (requires
jekyll to be installed and available on your path):
# Automatic verbose re-build whenever sources change jekyll build --watch --verbose # Development server available on http://127.0.0.1:4000 jekyll serve
Changing the header
Changing the menu
The menu is populated from the YAML file in
_data/navbar.yml. It should be enough to just customize
this file. The menu has two levels. On the first level you can specify a
and either a
url or a
sub (not both). If
url is specified the menu item
will link to that url. If
sub items are specified, hovering over a menu item
will open a dropdown menu, showing the sub items.
Sub items also have a
text and a
url that can be used analogously.
Additionally, subitems have a boolean
external variable that, if set to
true, adds a little external link icon next to the link text.
Changing the footer
General styles and layouts
Base styles are inherited from
_sass/rouge-github.scss. You should not modify
those styles, but rather override them in your own
_sass/main.scss, where currently all custom styles
are defined. All styles are included in
assets/css/style.scss, which gets compiled to css on
jekyll build. The resulting
assets/css/style.css is included in the default
Customizing and adding content
Adding content is as simple as creating
*.md files and filling
them with content.
Additionally, you should specify at least two properties in each file's YAML
front matter section, to tell jekyll
that you want to embed your content in the default layout and to give the
container in which your content will be placed a unique CSS id. This is what
front matter looks like:
--- layout: default css_id: my-funky-page ---
jekyll build each file in the project directory gets processed,
e.g. embedded in the the specified layout, and, in the case of markdown,
HTML. The result is copied to the build directory, i.e.
preserving relative paths, but changing the file extension to
You can read more about creating pages in the jekyll
favicon.ico should be served from the root of the project.
Just replace the current one with the
favicon.ico of your project.
This work is dual-licensed and distributed under (1) Apache License, Version 2.0 and (1) MIT License. Please see LICENSE and LICENSE-MIT.
This project is managed by Prof. Justin Cappos and other members of the Secure Systems Lab at NYU.
Uptane is supported by U.S. Department of Homeland Security grants D15PC00239 and D15PC00302. The views and conclusions contained herein are the authors’ and should not be interpreted as necessarily representing the official policies or endorsements, either expressed or implied, of the U.S. Department of Homeland Security (DHS) or the U.S. government.