Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Reminder to release under Apache rules #416

Merged
merged 4 commits into from
Apr 28, 2017
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# uPortal-app-framework

[![Gitter](https://badges.gitter.im/UW-Madison-DoIT/uw-frame.svg)](https://gitter.im/UW-Madison-DoIT/uw-frame?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Build Status](https://travis-ci.org/UW-Madison-DoIT/uw-frame.svg)](https://travis-ci.org/UW-Madison-DoIT/uw-frame)
[![Dependency Status](https://dependencyci.com/github/UW-Madison-DoIT/uw-frame/badge)](https://dependencyci.com/github/UW-Madison-DoIT/uw-frame)
Expand All @@ -6,16 +8,16 @@
[![Time to PR close](http://issuestats.com/github/uw-madison-doit/uw-frame/badge/pr)](http://issuestats.com/github/uw-madison-doit/uw-frame)
[![Time to issue close](http://issuestats.com/github/uw-madison-doit/uw-frame/badge/issue)](http://issuestats.com/github/uw-madison-doit/uw-frame)

UW Frame
=========
`uPortal-app-framework` is a front-end framework for building web applications that users experience as "apps in the portal".

uw-frame can be described as the "the framework for building applications for campus using modern technologies".
This package includes the MyUW header, settings, footer, and some reusable components :
This package includes the `uPortal-home` header, settings, footer, and some reusable components :

![uw-frame screenshot](uw-frame-screenshot.png "UW Frame")

Learn more about the reusable components on our [docs page](http://uw-madison-doit.github.io/uw-frame/)

`uPortal-app-framework` is somewhere in the process of renaming from its old `uw-frame` name.

## Requirements

* [node](https://nodejs.org/en/)
Expand Down Expand Up @@ -77,6 +79,7 @@ bundle into a deliverable war file.
To run the Jekyll docs locally:

> cd docs
>
> bundle exec jekyll serve

You may need to install the Jekyll bundler on your machine. See [Jekyll's quick-start guide](https://jekyllrb.com/docs/quickstart/) for instructions.
14 changes: 12 additions & 2 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# uw-frame release engineering
# uPortal-app-framework release engineering

Release engineering for uw-frame is pretty automated. We actually only have to do a few things.
Release engineering for `uPortal-app-framework` is pretty automated. We actually only have to do a few things.

## Release authorization

This project has [adopted Apache rules][] with necessary or pragmatic local adaptations.

Release authorization, or the delegation of release authority to one or more release engineers, should be documented by [a suitable vote][Apache Release Policy re Release Approval] of [the uPortal-app-framework Committers][] on [uportal-dev@][].

## Select a version

Expand Down Expand Up @@ -89,3 +95,7 @@ You don't have to do anything special to release the documentation. GitHub pages
[uw-frame-release-docs-version Jenkins job]: https://tools.my.wisc.edu/jenkins/view/Misc./job/uw-frame-release-docs-version/
[uw-frame releases]: https://github.com/UW-Madison-DoIT/uw-frame/releases
[MyUW Developer Group]: https://groups.google.com/forum/#!forum/myuw-developers
[adopted Apache rules]: https://github.com/UW-Madison-DoIT/uw-frame/blob/master/committers.md#rules
[Apache Release Policy re Release Approval]: http://www.apache.org/legal/release-policy.html#release-approval
[the uPortal-app-framework Committers]: https://github.com/UW-Madison-DoIT/uw-frame/blob/master/committers.md#who-are-the-committers
[uportal-dev@]: https://groups.google.com/a/apereo.org/forum/#!forum/uportal-dev