Skip to content

Commit

Permalink
first pass at project status page
Browse files Browse the repository at this point in the history
also includes some minor style changes that were apparently with a
simple content page like this
  • Loading branch information
willnorris committed Oct 12, 2021
1 parent 62c89d9 commit 8e8533e
Show file tree
Hide file tree
Showing 10 changed files with 155 additions and 2 deletions.
11 changes: 9 additions & 2 deletions assets/css/_main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@ body {
}
}

.content, .section {
.content {
padding: var(--feather-grid-mega) 0;
}
.section {
padding: calc(var(--feather-grid-mega) * 2) 0;
}

Expand Down Expand Up @@ -225,6 +228,10 @@ body {
line-height: var(--feather-line-height-large);
}

h2 {
margin: 1.5em 0 0.5em;
}

.center-text {
text-align: center;
}
Expand Down Expand Up @@ -352,7 +359,7 @@ br {

/* Less than 600px */
@media (max-width: 600px) {
.content, .section {
.section {
padding: calc(var(--feather-grid-mega) * 1.5) 0;
}

Expand Down
1 change: 1 addition & 0 deletions assets/css/memberships.scss
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ a.membership-handle:hover, a.membership-handle:active {
}

.membership h2 {
margin: 0;
padding-bottom: var(--feather-grid-micro);
}

Expand Down
138 changes: 138 additions & 0 deletions content/status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
title: Project Status
---

Open source projects come in all shapes and sizes, and Twitter's projects no
exception. Sometimes we publish projects that are highly experimental or are in
very early stages of development. Other times we publish some of the core
infrastructure that is used to serve hundreds of millions of tweets every day.

These project status labels, which you'll find attached to various Twitter
projects, are designed to help indicate how stable a project is and where it is
in its development lifecycle.


**Project Statuses:**
- [Idea](#idea)
- [Experimental](#experimental)
- [Active](#active)
- [Stable](#stable)
- [Unmaintained](#unmaintained)
- [Deprecated](#deprecated)
- [Retired](#retired)

## Idea

![status: idea](idea.svg)

### Expectations

This code is in the scoping or specification phase and may be accepting feedback or proposals. May not have active maintainers.

### Requirements

- Complies with Twitter's legal and security requirements for open source software
- Contains the appropriate Twitter open source category header in the repository's README file
- Typically hosted in the [Twitter Incubator](https://github.com/twitter-incubator) GitHub org
- (Optional) Issues at the project owner's discretion

## Experimental

![status: experimental](experimental.svg)

### Expectations

This code is not yet ready for prime time and may be actively seeking feedback. May not have active maintainers.

### Requirements

- Complies with Twitter's legal and security requirements for open source software
- Contains the appropriate Twitter open source category header in the repository's README file
- Typically hosted in the Twitter Incubator GitHub org
- (Optional) Issues at the project owner's discretion

## Active

![status: active](active.svg)

### Expectations

This code is actively maintained and supported.

### Requirements

- Complies with Twitter's legal and security requirements for open source software
- Contains the appropriate Twitter open source category header in the repository's README file
- Is maintained by a Twitter engineering team
- Issues and PR's managed in GitHub
- For additional details on support options, see the Open Source Support Policy
- An automated release pipeline

## Stable

![status: stable](stable.svg)

### Expectations

This code is stable and not necessarily open to new features or functionality. Is actively maintained and supported.

### Requirements

- Complies with Twitter's legal and security requirements for open source software
- Contains the appropriate Twitter open source category header in the repository's README file
- Is maintained by a Twitter engineering team
- Issues and PR’s managed in GitHub
- For additional details on support options, see the Open Source Support Policy
- An automated release pipeline

## Unmaintained

![status: unmaintained](unmaintained.svg)

### Expectations

This code is no longer actively maintained nor supported. Possibly actively searching for another maintainer inside or outside of Twitter.

### Requirements

- Complies with Twitter's legal and security requirements for open source software
- Contains the appropriate Twitter open source category header in the repository's README file
- Previous references to Support should be modified or removed from the README
- May be transitioned to new maintainers
- (Optional) Issues and PR's at the project owner's discretion

## Deprecated

![status: deprecated](deprecated.svg)

### Expectations

This code has been identified to transition to RETIRED at some point in the future. No longer supported and possibly has no active maintainers.

### Requirements

- Complies with Twitter's legal and security requirements for open source software
- Contains the appropriate Twitter open source category header in the repository's README file
- Previous references to Support should be modified or removed from the README
- Will be transitioned to RETIRED in the future
- (Optional) Issues and PR's at the project owner's discretion

## Retired

![status: retired](retired.svg)

### Expectations

This code is read-only. There is neither a maintainer nor any support.

### Requirements

- Complies with Twitter's legal and security requirements for open source software
- Contains the appropriate Twitter open source category header in the repository's README file
- Previous references to Support should be modified or removed from the README
- Project is read-only and available for cloning only

---
Thanks to [repostatus.org](https://www.repostatus.org/) and [New
Relic](https://opensource.newrelic.com/oss-category/) for the inspiration, and
[shields.io](https://shields.io/) for the badges.
1 change: 1 addition & 0 deletions static/status/active.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/status/deprecated.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/status/experimental.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/status/idea.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/status/retired.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/status/stable.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/status/unmaintained.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8e8533e

Please sign in to comment.