Skip to content

Commit 64b4c36

Browse files
authored
Add wiki implementation of InnerSource portal pattern (#637)
Add wiki implementation of InnerSource portal pattern. To structure the information more clearly, this adds a new "Implementation" section to this pattern, which complements the "Solution" and "Known Instances" section.
1 parent 58040ab commit 64b4c36

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

patterns/2-structured/innersource-portal.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,39 @@ Key properties of the portal are:
5252

5353
When launching the portal, a communications campaign promoting the addition of InnerSource data files or meta-data to code repositories should be considered, to bolster the number of projects displayed within the portal.
5454

55+
### Implementations
56+
57+
#### SAP Project Portal
58+
5559
A [reference implementation](https://github.com/SAP/project-portal-for-innersource) of an InnerSource portal is available on GitHub and open for contributions. It lists all InnerSource projects of an organization in an interactive and easy to use way. Projects can self-register using a dedicated GitHub topic and provide additional metadata.
5660

5761
![Example of an InnerSource Portal](../../assets/img/portal-overview.png "Example of an InnerSource Portal")
5862

63+
#### Wiki
64+
65+
As a simple way to start, you can set aside a page on an internal wiki for listing out available projects.
66+
An easy way to display this information is in a table with columns giving just a little bit of extra information about the projects.
67+
Try to have just enough columns so that viewers can determine if they want to learn more about the project, but no more.
68+
Too much information will make the page overwhelming and difficult to use.
69+
Individuals and teams can self-add their projects to the page.
70+
71+
Here is a sample set of columns:
72+
73+
* **Name**. Name of the project (optionally linked to its homepage).
74+
* **Brief Description**. Explaining the purpose of the project (which problem does it solve?)
75+
* **Technology Pre-requisites**. You must use these technologies in order to on-board to the project.
76+
* **Getting Started**. Link to instructions on how to start using the project.
77+
* **Chat**. Link to a chat channel to ask questions about the project.
78+
* **Host Team**. Seeing if a team is behind the project can help others to have the confidence to use it.
79+
* **Production Since**. How long as the project been used in a production environment? Seeing this information is a rough proxy for its maturity.
80+
* **Contribution**. Link to instructions on how to contribute to the project.
81+
82+
This solution doesn't allow for a fancy display - it is just a wiki table.
83+
If it's important for you to have a snazzy-looking UI, then this idea won't work for you.
84+
Additionally, if you end up with a lot of projects (e.g. nearing 100),
85+
this solution won't scale to allow the search and filtering or auto-updating of project entries that you'll probably need.
86+
It is a good solution for a portal with a few dozen projects, though.
87+
5988
## Resulting Context
6089

6190
* The InnerSource Portal has enabled InnerSource project owners to advertise their projects to an organization-wide audience. Due to this increased visibility they are attracting much larger communities of contributors than ever before.
@@ -78,6 +107,7 @@ A [reference implementation](https://github.com/SAP/project-portal-for-innersour
78107
* **Airbus** used the [SAP Portal](https://github.com/SAP/project-portal-for-innersource) as a Proof of Concept. It is now using the [Bazaar plugin](https://github.com/backstage/backstage/blob/master/plugins/bazaar/README.md) of [Backstage](https://backstage.io) as the latter became the official developer experience tool internally. It provides a convenient self-registering capability for all the divisions.
79108
* **Mercado Libre** use an instance of the [SAP portal](https://github.com/SAP/project-portal-for-innersource) to discover existing InnerSource projects within the organization.
80109
* **Mercedes-Benz** is [using](https://opensource.mercedes-benz.com/news/sponsor_innersource_commonsoss) the SAP reference implementation mentioned above for their InnerSource Portal.
110+
* **WellSky** has a simple _Confluence Wiki_ page were InnerSource and reusable projects are listed.
81111

82112
## References
83113

0 commit comments

Comments
 (0)