Skip to content

Commit 8879d39

Browse files
authored
Update dont-bother-looking.md
1 parent 6673b57 commit 8879d39

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

dont-bother-looking.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
## Title
2-
* Don't bother looking
2+
* Discover Your InnerSource
33

44
## Also Known As
5-
* Not looking for stuff internally
5+
* Not looking for stuff internally
6+
* Don't bother looking
7+
* Find it Inside
68

79
## Context
810
* Software component(s) are available internally but users can't easily find these.
11+
* This problem is more likely to occur in large, federated companies where different organizational units operate as silos.
12+
* Historically, the company does not have a culture of sharing code across silos.
13+
14+
## Discussion on
15+
* Comments may appear in the timeline but not with the file once it is edited (github)?
16+
* https://github.com/paypal/InnerSourcePatterns/pull/60
17+
* If only X knew what X knew; the internal search engine is bad. No one can find anything because it is difficult to add things to the search index.
18+
* We have similar challenges getting data sources pulled into the search engine. PayPal is building a project called Agora to do this and they are planning to open source it.
19+
* Github Enterprise and npmjs have built-in searches on meta-data. Enterprise that opts into these tooling will get some of that functi
20+
* Software component(s) are available internally but users can't easily find these.
921
* This problem is more likely to occur where there are silos in the company (e.g., larger companies; smaller companies may have fewer opportunities for reuse of internally developed software).
1022
* The company traditionally has been bad at sharing across silos (people don't have the culture of sharing).
1123

@@ -25,11 +37,13 @@ People don't bother looking for internally developed solutions - they might not
2537
## Solution
2638
Make it easy to find the reusable code.
2739

28-
* Pull in Repo names, descriptions and README.md files into the search engine
29-
* Implement process change to first check for internal solutions for this problem
40+
* 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.
41+
* Implement process change to first check for internal solutions for this problem.
3042
* Tool with a central view (but people are more inclined to google externally than look internally)
3143
* Concierge service (guide) to help product people find stuff. Might not scale but could be helpful in the beginning.
3244
* Need some very visible lighthouse projects that start using inner source components and make positive statements about the inner source program.
45+
* Establish a common, asynchronous communication channel (e.g., like slack or metamorph or yammer) across team boundaries. This might not scale beyond a certain organisation size. It is possible people will start splitting this one channel into multiple channels by topic once traffic gets too high. 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.
46+
* PLACEHOLDER FOR RUSS
3347

3448
## Known instances
3549

@@ -38,6 +52,7 @@ Make it easy to find the reusable code.
3852
* Developers looking for code can search for it and find it quickly.
3953
* Developers are now looking internally for software components
4054
* Search results are combined (internal and external)
55+
* See [Improved Findability](https://github.com/paypal/InnerSourcePatterns/blob/master/poor-naming-conventions.md) (aka Poor Naming Conventions or Badly Named Piles) as a related pattern.
4156

4257
## Status
4358
Brainstormed pattern idea in progress

0 commit comments

Comments
 (0)