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 Best Practices text. The current head of the master branch is built automatically by GitHub and deployed at https://uptane.github.io/deployment-considerations.
You can make a PDF or self-contained HTML rendering of the contents of all deployment pages. To do this, you will need GNU make (BSD make won't work) and Docker.
If you've got those prerequisites, just run make pdf or make html to generate the respective release files.
This builds the document from the file uptane-deployment-considerations-release.md, which simply includes all of the relevant markdown files. If a new page is added or a page is removed, this file will need to be edited accordingly.
The title of the document will be Uptane Deployment Best Practices v.$(RELEASE_VERSION). If the RELEASE_VERSION variable is set in the shell, that value will be used. Otherwise, it will look for a git tag; if one is found, that will be used as the version. If there is no tag on the current commit and RELEASE_VERSION is not set in the environment, it will be set to $(DATE)-DRAFT-$(COMMIT_ID), e.g. 2021-01-27-DRAFT-a3d478d.
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 serveSet 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.
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.
Just customize _includes/footer.html.
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.
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.
Add assets, e.g., images or JavaScript, to assets.
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.
Uptane is a Joint Development Foundation project of the Linux Foundation, operating under the formal title of Joint Development Foundation Projects, LLC, Uptane Series. This project is managed by Prof. Justin Cappos and other members of the Secure Systems Lab at NYU. Contributors and maintainers are governed by the CNCF Community Code of Conduct.
Uptane was initiated with support from 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.