Skip to content

Commit 16d30ff

Browse files
committed
Format the InnerSource tooling documents
1 parent 524e14f commit 16d30ff

File tree

7 files changed

+69
-0
lines changed

7 files changed

+69
-0
lines changed

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,4 @@
3535
* [GitHub Configuration](tooling/github-configuration.md)
3636
* [GitLab Strategy](tooling/gitlab-strategy.md)
3737
* [GitLab Configuration](tooling/gitlab-configuration.md)
38+
* [Authors and Reviewers](tooling/authors.md)

tooling/authors.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Authors
2+
3+
(Chronological order)
4+
5+
- Justin Gosses ([Microsoft](https://microsoft.com/))
6+
- Yuki Hattori ([GitHub](https://github.com/))
7+
8+
## Reviewers
9+
10+
(Chronological order)

tooling/github-configuration.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# GitHub InnerSource Configuration
22

3+
- [Enterprise Setting](#enterprise-setting)
4+
- [Repository policies](#repository-policies)
5+
- [Base permissions](#base-permissions)
6+
- [Repository creation](#repository-creation)
7+
- [Repository forking (Private / Internal)](#repository-forking-private--internal)
8+
- [Organization Setting](#organization-setting)
9+
- [Member privileges](#member-privileges)
10+
- [Base permissions](#base-permissions-1)
11+
- [Repository creation](#repository-creation-1)
12+
- [Repository forking](#repository-forking)
13+
- [GitHub Enterprise Server Setting](#github-enterprise-server-setting)
14+
- [GitHub Connect - Server statistics](#github-connect---server-statistics)
15+
- [Resources](#resources)
16+
317
## Enterprise Setting
418

519
### Repository policies

tooling/github-strategy.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# GitHub InnerSource Strategies
22

3+
- [Balancing Security \& InnerSource: Who Can See What](#balancing-security--innersource-who-can-see-what)
4+
- [Security-First Perspective and InnerSource-first Perspective](#security-first-perspective-and-innersource-first-perspective)
5+
- [Visibility Differences by InnerSource Project Type](#visibility-differences-by-innersource-project-type)
6+
- [Project Participation Difficulty Level by Setting](#project-participation-difficulty-level-by-setting)
7+
- [Pros and Cons of InnerSource Dedicated Environment](#pros-and-cons-of-innersource-dedicated-environment)
8+
- [Variations in how repository read access is distributed](#variations-in-how-repository-read-access-is-distributed)
9+
- [Conclusion: High Level Guideline](#conclusion-high-level-guideline)
10+
311
## Balancing Security & InnerSource: Who Can See What
412

513
The section explores the delicate balance between security and collaboration in the context of InnerSource projects. Within an InnerSource project, transparency plays a vital role in fostering collaboration and encouraging participation. Ideally, the project should be structured to allow as many individuals as possible to contribute, ensuring that the barriers to participation are kept low. However, it's important to acknowledge that certain constraints and considerations may prevent making everything openly accessible within the company.

tooling/gitlab-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# GitLab InnerSource Configuration

tooling/gitlab-strategy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# GitLab InnerSource Strategies

tooling/innersource-tooling.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# InnerSource with GitHub
2+
3+
## Effective InnerSource Strategies and Configuration for GitHub
4+
5+
This documentation is a compilation of the essential settings and strategies necessary for implementing InnerSource inside an organization. It encompasses both overall strategic elements and specific points relating to SCM configuration.
6+
7+
## Table of Contents
8+
9+
### GitHub
10+
11+
- [GitHub InnerSource Strategies](tooling/github-strategy.md#github-innersource-strategies)
12+
- [Balancing Security \& InnerSource: Who Can See What](tooling/github-strategy.md#balancing-security--innersource-who-can-see-what)
13+
- [Security-First Perspective and InnerSource-first Perspective](tooling/github-strategy.md#security-first-perspective-and-innersource-first-perspective)
14+
- [Visibility Differences by InnerSource Project Type](tooling/github-strategy.md#visibility-differences-by-innersource-project-type)
15+
- [Project Participation Difficulty Level by Setting](tooling/github-strategy.md#project-participation-difficulty-level-by-setting)
16+
- [Pros and Cons of InnerSource Dedicated Environment](tooling/github-strategy.md#pros-and-cons-of-innersource-dedicated-environment)
17+
- [Variations in how repository read access is distributed](tooling/github-strategy.md#variations-in-how-repository-read-access-is-distributed)
18+
- [Conclusion: High Level Guideline](tooling/github-strategy.md#conclusion-high-level-guideline)
19+
- [GitHub InnerSource Configuration](tooling/github-configuration.md/#github-innersource-configuration)
20+
- [Enterprise Setting](tooling/github-configuration.md/#enterprise-setting)
21+
- [Repository policies](tooling/github-configuration.md/#repository-policies)
22+
- [Base permissions](tooling/github-configuration.md/#base-permissions)
23+
- [Repository creation](tooling/github-configuration.md/#repository-creation)
24+
- [Repository forking (Private / Internal)](tooling/github-configuration.md/#repository-forking-private--internal)
25+
- [Organization Setting](tooling/github-configuration.md/#organization-setting)
26+
- [Member privileges](tooling/github-configuration.md/#member-privileges)
27+
- [Base permissions](tooling/github-configuration.md/#base-permissions-1)
28+
- [Repository creation](tooling/github-configuration.md/#repository-creation-1)
29+
- [Repository forking](tooling/github-configuration.md/#repository-forking)
30+
- [GitHub Enterprise Server Setting](tooling/github-configuration.md/#github-enterprise-server-setting)
31+
- [GitHub Connect - Server statistics](tooling/github-configuration.md/#github-connect---server-statistics)
32+
- [Resources](tooling/github-configuration.md/#resources)
33+
34+
### GitLab

0 commit comments

Comments
 (0)