Skip to content

Commit 94ab652

Browse files
committed
Merge branch 'promote-discover-your-innersource' of github.com:jeffabailey/InnerSourcePatterns into promote-discover-your-innersource
2 parents 4d8a55f + f00bff2 commit 94ab652

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

patterns/2-structured/discover-your-innersource.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,25 @@ People don't bother looking for internally developed solutions - they might not
3232

3333
Make it easy to find the reusable code.
3434

35-
* Pull in Repo names, descriptions and README.md files into the search engine assuming that a search engine exists. Note: a one-stop-shop kind of search engine for all relevant communication and documentation is difficult to attain. Even when using Github's enterprise offering, people often deploy additional systems like wikis to host content orthogonal to what is in the code repositories, slack channels (or IRC), mailing lists (or even nntp servers), some place to store stuff written down in office formats, search over personal e-mail etc. Several of these systems come with search built-in, but integrating this content in one search box or even just deploying a federated search engine across all sources often doesn't come off-the-shelf.
35+
### Behavior and Process Changes
36+
37+
* Implement process change to motivate developers to first check for internal solutions for problems that they need to solve.
38+
* Concierge service (guide) to help product people find stuff. Might not scale but could be helpful in the beginning.
39+
* Need some very visible lighthouse projects that start using InnerSource components and make positive statements about the InnerSource program (to increase the trust of your developers in your InnerSource components.
40+
* Encourage (and reward) owners of reusable code to use the same search engine to continually search for products that are candidates for use and adoption of the reusable code but not currently doing so.
41+
42+
### Tooling Changes
43+
44+
* Pull in repo names, descriptions and `README.md` files into the search engine assuming that a search engine exists. Note: a one-stop-shop kind of search engine for all relevant communication and documentation is difficult to attain. Even when using GitHub's enterprise offering, people often deploy additional systems like wikis to host content orthogonal to what is in the code repositories, slack channels (or IRC), mailing lists (or even nntp servers), some place to store stuff written down in office formats, search over personal e-mail etc. Several of these systems come with search built-in, but integrating this content in one search box or even just deploying a federated search engine across all sources often doesn't come off-the-shelf.
3645
* Consider using existing tools:
3746
* GitHub Enterprise and npmjs have built-in searches on meta-data
3847
* PayPal's [SeazMe](https://github.com/paypal/seazme) project (previously called Agora) addresses similar challenges with data source integration
39-
* Implement process change to first check for internal solutions for this problem.
4048
* Tool with a central view (but people are more inclined to google externally than look internally)
41-
* Concierge service (guide) to help product people find stuff. Might not scale but could be helpful in the beginning.
42-
* Need some very visible lighthouse projects that start using InnerSource components and make positive statements about the InnerSource program.
4349
* Establish a common, asynchronous communication platform (e.g., chat based) across team boundaries.
4450
* This might not scale beyond a certain organization size.
4551
* Start with a single chat channel for the InnerSource project, splitting into multiple only when traffic is high. This keeps the channel active and minimizes channels for the host team. Mention this channel clearly in key docs like README.md, CONTRIBUTING.md, and onboarding materials to help users find and join the conversation.
4652
* Note: having one channel for many users of one tool might be considered an anti-pattern because they can't find it unless they already know about it.
47-
* Encourage (and reward) owners of reusable code to use the same search engine to continually search for products that are candidates for use and adoption of the reusable code but not currently doing so.
48-
* Consider creating a marketplace for marketing InnerSource programs (management can use this mechanism to know which InnerSource projects to fund, but seeing how the marketplace reacts). - see [Gig Marketplace](../2-structured/gig-marketplace.md)
53+
* Create a marketplace for marketing InnerSource programs (management can use this mechanism to know which InnerSource projects to fund, by seeing how the marketplace reacts). - see [Gig Marketplace](../2-structured/gig-marketplace.md)
4954

5055
## Resulting Context
5156

@@ -54,7 +59,12 @@ Make it easy to find the reusable code.
5459
* Developers are now looking internally for software components
5560
* Search results are combined (internal and external)
5661
* Process changes, establishing a common communications channel, and encouraging and rewarding owners of reusable code to use the same search engine can contribute to changing the corporate culture. Transformation begins from the grassroots but requires strategic involvement of thought leaders.
62+
63+
<!--
64+
// we don't want to link from Structured patterns to Initial patterns. hence removing this link.
65+
// we can add this back in if the "Improved Findability" pattern is leveled up to maturity Structured
5766
* See [Improved Findability](../1-initial/improve-findability.md) (aka Poor Naming Conventions or Badly Named Piles) as a related pattern.
67+
-->
5868

5969
## Known Instances
6070

0 commit comments

Comments
 (0)