Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/INN/docs

INN Labs – Product & Technology Team Docs
https://github.com/INN/docs

documentation

Last synced: about 1 month ago
JSON representation

INN Labs – Product & Technology Team Docs

Host: GitHub
URL: https://github.com/INN/docs
Owner: INN
Created: 2014-05-20T14:30:51.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2021-07-02T18:08:33.000Z (over 3 years ago)
Last Synced: 2024-08-02T12:51:24.494Z (4 months ago)
Topics: documentation
Language: Shell
Homepage: https://labs.inn.org
Size: 1.4 MB
Stars: 69
Watchers: 20
Forks: 29
Open Issues: 49
Metadata Files:
- Readme: README.md
- Contributing: contributing.md

Awesome Lists containing this project

awesome-starred - INN/docs - INN Labs – Product & Technology Team Docs (documentation)

README

        # INN Labs – News Apps And Technology Team Docs

### Table of Contents

**What's in here (so far):**

-  **[A manifesto](manifesto.md)** outlining our team's mission and values

-  **[Staffing and Hiring](/staffing)** including how we recruit and hire new team members, plus:

    - [Some information](/staffing/hiring/application-process.md) on our application/interview process

	- [Sample job descriptions](/staffing/job-postings/readme.md) from our team and from INN member organizations

	- [Interview questions](/staffing/hiring/interview-questions.md) for screening candidates

	- [Our onboarding process](/staffing/onboarding)

-  **[How we work](/how-we-work)** including:

	- [Our internal process](/how-we-work/process.md) we follow for most of our projects

	- [What we've learned about working as a remote team](/how-we-work/remote-work.md)

	- [The tools we use](/how-we-work/tools.md)

	- [Notes on how we conduct meetings](/how-we-work/meetings.md)

	- [How we give feedback to other team members](/how-we-work/feedback.md)

	- [How we use GitHub and Git for version control](/how-we-work/version-control.md)

-  **[How to work with us](/how-to-work-with-us)** including:

	- [General guidelines](/how-to-work-with-us) for how to work with us effectively

	- [Services we offer to INN members](/how-to-work-with-us/member-services.md)

	- [Details of our paid consulting program](/how-to-work-with-us/consulting/readme.md)

	- [Intake documents](/how-to-work-with-us/intake-procedure.md) for new projects

	- [A code of conduct](/how-to-work-with-us/contributing.md) for contributing to our open source projects

	- [How to contribute to our projects using GitHub](/how-to-work-with-us/via-github.md)

	- [Guidelines for submitting great pull requests](/how-to-work-with-us/pull-requests.md)

-  **[Style guides](/style-guides)** for:

	- [Code](/style-guides/code)

	- [Design/ui](/style-guides/design) elements

	- [Data projects](/style-guides/data)

-  **[Projects](/projects)** we work on with descriptions of each project and relevant resources.

-  **[Checklists](/checklists)** to help keep us organized.

-  **[Our Communications Strategy](/communications)** including:

	-  External communications

		- [Our weekly newsletter](/communications/newsletter)

		- [Twitter accounts](/communications/twitter.md)

	- [Internal communications](/communications/internal-communications).

**What is not (and will not) be in here:**

-  Documentation for [Largo](http://largoproject.org) and some of our other large projects which will typically be kept with their respective project repos as well as on [Read the Docs](https://readthedocs.org/).

-  Documentation for our other apps/tools/etc. (e.g. our [deployment tools](https://github.com/INN/deploy-tools) or our [responsive tables](https://github.com/INN/responsive-tables) rig) that are on the smaller side will typically reside within those repos directly as a readme file at the root of the repository.

**Important Note:** Nothing in these docs supercedes what you'll find in the [INN employee manual](https://docs.google.com/document/d/1MkXPsg6nD3yAfwXWczhscdoze7QhHgsrd_vLK1uQPB4/edit). Always refer to that for any personnel, hiring, payroll, etc. issues.

### Thanks!

These docs draw on (and sometimes straight up steal) excellent work from teams that have come before us. Here are a few of our sources of inspiration:

- [ProPublica's News App and Data Style Guides](https://github.com/propublica/guides)

- The NPR Visuals Team's [app template](https://github.com/nprapps/app-template), [coding best practices](https://github.com/nprapps/bestpractices) and [manifesto](http://blog.apps.npr.org/2014/06/04/how-we-work.html)

- [Guides](https://github.com/newsapps/guides) and [Process Docs](https://web.archive.org/web/20160909203500/http://blog.apps.chicagotribune.com/2014/03/05/everything-you-ever-wanted-to-know-about-the-news-apps-process/) from The Chicago Tribune's News Apps Team

- [MinnPost's UI Style Guide](https://github.com/MinnPost/minnpost-styles)

[](https://browserstack.com)

The INN Nerds use [BrowserStack](https://browserstack.com) to test our apps for cross-browser compatibility on real browsers. 

### License

All of these documents are licensed under a [Creative Commons BY-NC 3.0](http://creativecommons.org/licenses/by-nc/3.0/) license. You are free to share and to remix them (as long as you credit us) but please don't use them commercially without permission.

### Contributing

We welcome contributions and suggestions to help us improve any of these documents. Please start by [reading our contribution guidelines](/how-to-work-with-us/contributing.md) and then [review the specifics](contributing.md) for this project to get started.

### Who Wrote This?

The INN news apps and technology team is:

-  **[Kay Lima](https://github.com/kaylima)** ([@kayleen_lima](http://twitter.com/kayleen_lima)), Director

-  **[Ben Keith](https://github.com/benlk)** ([@benlkeith](http://twitter.com/benlkeith)), Lead Developer

-  **Joshua Darby**, Senior Developer

-  **Miranda Krapf**, Project Manager

-  **Paola Baradello**, Account Manager

**Head Nerd emeritus:** **[Adam Schweigert](https://github.com/aschweigert)** ([@aschweig](http://twitter.com/aschweig))

**Nerds emeriti:** [Nick Bennett](https://github.com/tothebeat), [Jack Brighton](http://github.com/jackbrighton), [Will Haynes](https://github.com/willhaynes), [Kaeti Hinck](https://github.com/kaeti), [Gabriel Hongsdusit](https://github.com/gabehong), [Dani Litovsky Alcalá](https://github.com/danilito19), [Denise Malan](https://github.com/dnmalan), [Meredith Melragon](https://github.com/meredithinn), [Ryan Nagle](https://github.com/rnagle), [Sinduja Rangarajan](https://github.com/cynduja), [David Ryan](https://github.com/dryanmedia), [RC Lations](https://github.com/rclations), [Julia Smith](https://github.com/julia67) ([@julia67](https://twitter.com/julia67)), [Tyler Machado](https://github.com/tylermachado) ([@tylermachado](https://twitter.com/tylermachado))

**Additional contributions from:** [@chriszs](https://github.com/chriszs) and [@brentajones](https://github.com/brentajones)