Skip to content

Commit 1e7e215

Browse files
committed
more edits, sleep is for wimps
1 parent 13c4a29 commit 1e7e215

13 files changed

+34
-39
lines changed

how-to-work-with-us/consulting/readme.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ But it's hard for us to help every member individually and there are many member
1818

1919
- Want to use the tools we have built (particularly Largo) but may require some help setting them up or customizing them to suit their needs
2020
- In some cases may require additional custom development to add functionality that we have not yet built
21-
- Would be willing to pay (provided our rates are competitive) for our services and even pay us to host their sites in the same way we host sites for members.
21+
- Would be willing to pay (provided [our rates](consulting-rates.md) are competitive) for our services and even pay us to host their sites in the same way we host sites for members.
2222

2323
Until now we’ve been referring people to outside contractors and freelancers, but as we continue to grow our technology team we have the capability to take on <em>some</em> of this work ourselves.
2424

25-
For INN members, we will subsidize the cost of these services to keep them very affordable (see the rates section below for details). We will also, from time to time, take on work from non-members (at regular market rates).
25+
For INN members, we will subsidize the cost of these services to keep them very affordable (see [our rates](consulting-rates.md) for details). We will also, from time to time, take on work from non-members (at regular market rates).
2626

2727
**Some examples of the services we offer include:**
2828

2929
- Content migration, design customization and custom development for members using our Largo platform beyond what we're able to do for "free" as a benefit of INN membership
30-
- Assistance with editorial design and development for news apps, data projects or special series
30+
- Assistance with editorial design and development for news apps, data projects or special projects
3131
- Ongoing or project-based support, training and assistance with story production
32-
- Design and development of microsites or other special projects
32+
- Assistance with general technology strategy, recruiting and hiring, and building and managing technology resources at your organization.
3333

3434
**Taking on this additional paid work will allow us to:**
3535

@@ -42,4 +42,4 @@ We hope that this new program will be a win-win for members and for INN and that
4242

4343
If you're interested in working with us, we'd love to discuss your needs and how we can help. [Get in touch with us here](mailto:[email protected]) to learn more.
4444

45-
We've also assembled an FAQ to provide more detail on the program.
45+
We've also assembled a list of [frequently asked questions](consulting-faq.md) to provide more detail on the program.

how-to-work-with-us/contributing.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# Code of conduct and how to contribute
22

3-
Since the INN nerds team works primarily with open source projects in public spaces, we think it's important to identify some community guidelines for how we like to work, what we expect from the people we work with, and how to contribute to our projects.
3+
Since the INN nerds team works primarily with open source projects in public spaces, we think it's important to identify some community guidelines for how we like to work, what we expect from the people we work with and how to contribute to our projects.
44

5-
## Code of conduct
5+
### Code of conduct
66

77
1. Be welcoming, friendly, patient, kind, courteous and respectful.
88
2. Use your best judgment — if you're not sure about something, ask.
9-
3. When you mess up, own up to your mistake and apologize (except in instances where apologizing would do more harm).
10-
4. If you repeatedly violate this code of conduct, you will no longer be welcome to contribute to our projects.
9+
3. We welcome contributions from people of any skill level and are committed to helping you build your skills wherever and however we can. Never be afraid to ask questions (even if you feel like they're too basic to bother us; you're not). [We're all impostors](http://geekfeminism.wikia.com/wiki/Impostor_syndrome).
10+
4. When you mess up, own up to your mistake and apologize (except in instances where apologizing would do more harm).
11+
5. If you repeatedly violate this code of conduct, you will no longer be welcome to contribute to our projects.
1112

1213

1314
### What this means (our social rules)
1415

15-
##### Give constructive criticism
16+
**Give constructive criticism**
1617

1718
Be friendly and offer well-reasoned opinions of someone's work or ideas, whether your critique is positive or negative.
1819

@@ -23,7 +24,7 @@ Dismissing an idea out of hand is unacceptable. An explanation and support for y
2324
Set personal conflicts aside when giving critique. Focus on the merits of the idea or work, not the person presenting them.
2425

2526

26-
##### Create a safe space for learning
27+
**Create a safe space for learning**
2728

2829
Everyone should feel comfortable saying, "I don't know." Everyone should feel comfortable asking questions and requesting help.
2930

@@ -35,7 +36,7 @@ The [Hacker School User's Manual](https://www.hackerschool.com/manual) does a gr
3536
- [No subtle-isms](https://www.hackerschool.com/manual#no-subtle-isms)
3637

3738

38-
##### Professionalism
39+
**Professionalism**
3940

4041
Remember that this is a public space. Act accordingly.
4142

@@ -46,14 +47,14 @@ Harassment and exclusionary behavior include offensive verbal comments related t
4647
<sup>*</sup>From the [Conference Code of Conduct](http://confcodeofconduct.com/)
4748

4849

49-
## How to contribute code
50+
###How to contribute code
5051

5152
- Send us pull requests for bug fixes and small suggestions.
5253
- For feature requests, create an issue to start a discussion. We'll decide together whether or not the requested feature gets built. Be sure and explain clearly why your feature request is essential.
53-
- For detailed information about our preferred code structure and styles, refer to our [code style guide](https://github.com/INN/docs/tree/master/style-guides/code).
54+
- For detailed information about our preferred code structure and styles, refer to our [code style guide](/style-guides/code).
5455

5556

56-
## Other resources
57+
###Other resources
5758

5859
This document is based on similar documents created by other organizations. Inspiration for this guide came from the following:
5960

@@ -63,4 +64,4 @@ This document is based on similar documents created by other organizations. Insp
6364
- [Conference Code of Conduct](http://confcodeofconduct.com/)
6465
- [Hacker School User's Manual](https://www.hackerschool.com/manual#sub-sec-social-rules)
6566

66-
If you have questions about the code of conduct or how to contribute, feel free to contact us: [email protected].
67+
If you have questions about the code of conduct or how to contribute, feel free to contact us: [[email protected]](mailto:[email protected]).

how-to-work-with-us/intake-procedure.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# How to Work With Us
22

3-
We love making things and we love helping our members and clients publish great journalism. We want to make it easy for you to approach us with ideas and projects, and we want you to know what to expect when working with us.
3+
We love making things and helping our members and clients perform acts of great journalism. We want to make it easy for you to approach us with ideas and projects, and we want you to know what to expect when working with us.
44

5-
**When you approach us with a project**, we'll talk about the idea as a team and review the requirements and expectations. We strongly recommend you familiarize yourself with [our process](https://github.com/INN/docs/blob/master/how-we-work/process.md) so you know what to expect.
5+
**When you approach us with a project**, we'll talk about the idea as a team and review the requirements and expectations. We strongly recommend you familiarize yourself with [our process](/how-we-work/process.md) so you know what to expect.
66

77
**To get in touch** with the team, send an email to [[email protected]](mailto:[email protected]). Include a brief project description, what you hope to accomplish, and any timeline considerations we should know about.
88

@@ -14,7 +14,7 @@ We love making things and we love helping our members and clients publish great
1414

1515
**Maintenance:** As part of our contract, we'll work with you to identify any ongoing maintenance needs for a project, and if necessary create a plan to archive or retire projects that have a shorter shelf life. We won't ever leave you with a mess to clean up.
1616

17-
**Approach us with problems or questions, not solutions.** To do our best work, we prefer to start with the question or problem we're trying to solve, and build a feature or product from there. Often times the first or most obvious solution isn't the best one and we want to make sure you succeed. Here are a few examples of what that can look like:
17+
**Approach us with problems or questions, not solutions.** To do our best work, we prefer to start with the question or problem we're trying to solve, and work with you to build a feature or product from there. Often times the first or most obvious solution may not be the best one and we want to be a partner with you in crafting the best solution because we are invested in your success. Here are a few examples of what that can look like:
1818

1919

2020
Better :thumbsup: | Worse :thumbsdown: |
@@ -25,7 +25,7 @@ We want to tell this important story in a big way that sets it apart | Build us
2525
We want readers to know what our current top stories are | Can you add a carousel to the homepage? ([Ahem.](http://shouldiuseacarousel.com/)) |
2626

2727
###Get in touch!
28-
We'd love to [hear from you](mailto:[email protected]).
28+
Have a product idea you'd like us to help you with? We'd love to [hear from you](mailto:[email protected]).
2929

3030

3131

how-to-work-with-us/member-services.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,15 @@ We help our members become more sustainable by listening carefully to their need
66

77
**This means that we will:**
88

9-
- **Identify common needs** that a number of members share. (We are often unable to provide one-on-one assistance for free and instead offer paid consulting services to members at a highly reduced rate.)
10-
- **Build platforms and tools to address these needs** but recognize that each member is different and the tools we build need to be customizable to suit these needs. For example, with Largo, we save members time and money by eliminating 90 percent of the effort typically involved in building a WordPress news website because the needs of sites are very similar, thus freeing you up to spend your time and money on the last 10 percent that is unique to your organization (mostly look and feel).
9+
- **Identify common needs** that a number of members share. (We are often unable to provide one-on-one assistance for free and instead offer [paid consulting services](/how-to-work-with-us/consulting) to members at a highly reduced rate.)
10+
- **Build platforms and tools to address these needs** but recognize that each member is different and the tools we build need to be customizable to suit these needs. For example, with [Largo](http://largoproject.org), we save members time and money by aiming to eliminate 90 percent of the effort typically involved in building a WordPress news website because the needs of sites are very similar, thus freeing you up to spend your time and money on the last 10 percent that is unique to your organization (mostly look and feel, in our experience).
1111
- **Invest in documentation, group training and resources** to help members use and get the most out of the tools we build.
1212
- **Negotiate on our members' behalf** to get free or reduced pricing for common third-party software and services.
1313

1414
Information on how to become a member, membership standards, dues, etc., [can be found on the INN website](http://investigativenewsnetwork.org/members/become-a-member/).
1515

16-
1716
### As part of their INN membership our members receive:
1817

19-
2018
**For members using [Largo](http://largoproject.org) (our WordPress framework/platform):**
2119

2220
- **Up to 32 hours of complimentary assistance** with setup and configuration if they use our shared hosting.
@@ -25,28 +23,24 @@ Information on how to become a member, membership standards, dues, etc., [can be
2523
- **Free access to fonts** from [Adobe's Typekit library](https://typekit.com/).
2624
- **Site licenses** for a number of premium WordPress plugins.
2725

28-
2926
**For members participating in collaborative investigations and data projects:**
3027

3128
- **News applications and interactive features** to support collaborative investigations, localizable and flexible enough to work on a variety of member websites regardless of CMS.
3229
- **Help with integrating these apps/features** into your stories and websites.
3330
- **Promotion of member stories** through our website, newsletters and social media.
3431

35-
3632
**For members who want to use the tools we build:**
3733

3834
- **Easy to understand documentation** to help members get up and running with any tools we build and open source.
3935
- **Individual assistance**. We always recommend reading the documentation first (and helping us improve it if we miss something!), but if you get stuck we're happy to provide assistance and answer any questions you might have.
4036
- **We love feedback** and wherever possible we will prioritize feature requests from members.
4137

42-
4338
**For all members:**
4439

45-
- **Discounted rates on paid consulting** — currently $50/hr for members, reduced from our regular rate of $150/hr.
40+
- **[Discounted rates](/how-to-work-with-us/consulting/consulting-rates.md) on paid consulting** — currently $50/hr for members, reduced from our regular rate of $150/hr.
4641
- **Open office hours** the first Thursday of the month from 3-5 p.m. CT. Members can sign up for a 30 minute (or more if you clear it with us in advance) block to meet with our entire team and get feedback on any tech related issues you might be facing (new project ideas, critique of works in progress, general tech/strategy/design questions). Since we're a remote team, these will be Google hangouts and can be either public (anyone can join or watch) or private (if you want to keep the conversation just between us).
4742
- **General tech help**. Please consider signing up for our open office hours and/or paid consulting services, but when time and resources allow we're happy to answer general tech questions as they come up and help in any way we can.
4843

49-
5044
**For developers at member organizations:**
5145

5246
- **Support for open source projects**. As a team we're committed to supporting members' open source projects. If you need help with something feel free to reach out to us.

how-we-work/process.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
##Our Process
2-
1+
#Our Process
32

43
This is a general framework for how our team approaches our work. Depending on the scope of the project, we may use an abbreviated version or add more checkpoints and iterations.
54

@@ -52,7 +51,7 @@ This is a general framework for how our team approaches our work. Depending on t
5251

5352

5453

55-
####Jargon, defined
54+
###Jargon, defined
5655
**Stakeholders:** The people who are meaningfully involved in a project and have influence/decision-making power.
5756

5857
**User:** Anybody who is going to end up using the feature or product. These are often your readers, but don't forget about internal users (editors, reporters, business staff, etc.).

how-we-work/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
Notes on how we work together as a team.
44

55
### What's in here (so far):
6+
- [The process](process.md) we follow for each of our projects
67
- [What we've learned about working as a remote team](remote-work.md)
78
- [The tools we use](tools.md)
89
- [Meetings](meetings.md) - Description of our general meeting philosophy, daily scrum and weekly recap meetings
910

1011
### Still todo:
11-
- flesh out the [process doc](process.md)
1212
- Issue tracking procedure (maybe this is just a section of the process doc)

how-we-work/tools.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ These are some of the tools we rely on to make our remote work possible.
99
- **[Screenhero](https://screenhero.com/):** Remote pair programming software
1010
- **[Google Hangouts](https://plus.google.com/hangouts):** For [meetings](meetings.md) and daily scrum
1111

12+
We maintain [a list of tools and services](http://nerds.investigativenewsnetwork.org/discounts/) (including many of the above) that offer discounts to nonprofits on our team blog.

style-guides/code/assets.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Best Practices for Assets
1+
# Best Practices for Assets
22

33
### General
44

style-guides/code/html_and_css.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Best Practices for HTML and CSS
1+
# Best Practices for HTML and CSS
22

33
* Element IDs and class names should always be ``lowercase-with-dashes``.
44
* Put modals and JST templates in their own files. If using our fork of the NPR app template these belong in the `templates` and `jst` directories, respectively. When this isn't feasible, put modals in the page footer first, followed by inline javascript templates.

style-guides/code/javascript.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Best Practices for Javascript
1+
# Best Practices for Javascript
22

33
### General
44

style-guides/code/php.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Best Practices for PHP
1+
# Best Practices for PHP
22

33
### Baseline
44

style-guides/code/python.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Best Practices for Python
1+
# Best Practices for Python
22

33
### Baseline
44

style-guides/code/wordpress.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Best Practices for WordPress
1+
# Best Practices for WordPress
22

33
### Baseline
44

0 commit comments

Comments
 (0)