Skip to content
Deployment Considerations and Best Practices for Uptane
CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_data Fix index.html Jul 17, 2019
_includes Add scaffolding and draft content Jul 17, 2019
_layouts Add scaffolding and draft content Jul 17, 2019
_sass Add scaffolding and draft content Jul 17, 2019
assets Add files via upload Sep 10, 2019
.gitignore Add scaffolding and draft content Jul 17, 2019
LICENSE Add scaffolding and draft content Jul 17, 2019
LICENSE-MIT
README.md Minor readme edit Jul 17, 2019
_config.yml Use navbar that mimics main site Jul 17, 2019
asn1_examples.md Add scaffolding and draft content Jul 17, 2019
customizations.md Update customizations.md Sep 17, 2019
ecus.md Update ecus.md Sep 13, 2019
exceptional_operations.md Add scaffolding and draft content Jul 17, 2019
favicon.ico Add scaffolding and draft content Jul 17, 2019
index.md added POUF description to the home page Jul 31, 2019
key_management.md Further clarification of offline keys and recalls. Sep 3, 2019
normal_operation.md
repositories.md Update repositories.md Sep 13, 2019
security_considerations.md

README.md

Uptane Deployment Considerations website

Uptane's project website is created with Jekyll and extends the GitHub pages slate theme.

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

Basic commands

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

Set the variables title, description and logo_url in _config.yml to customize the header. These variables are used in _layouts/default.html to populate 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 text 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.

The menu is styled in _sass/navbar.scss and its markup can be found in _includes/navbar.html, which is included in the default layout.

Changing the footer

Just customize _includes/footer.html.

General styles and layouts

Base styles are inherited from _sass/jekyll-theme-slate.scss and _sass/rouge-github.scss. You should not modify those styles, but rather override them in your own _sass/*.scss or in _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 layout.

Customizing and adding content

Adding content is as simple as creating *.html, or *.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
---

When running jekyll build each file in the project directory gets processed, e.g. embedded in the the specified layout, and, in the case of markdown, converted to HTML. The result is copied to the build directory, i.e. _site, preserving relative paths, but changing the file extension to .html. You can read more about creating pages in the jekyll docs.

Adding assets

Add assets, e.g. images or JavaScript, to assets.

Replace favicon.ico

favicon.ico should be served from the root of the project. Just replace the current one with the favicon.ico of your project.

License

This work is dual-licensed and distributed under (1) Apache License, Version 2.0 and (1) MIT License. Please see LICENSE and LICENSE-MIT.

Acknowledgements

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.

You can’t perform that action at this time.