Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add wiki implementation of InnerSource portal pattern #637

Merged
merged 5 commits into from
Jan 2, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions patterns/2-structured/innersource-portal.md
Original file line number Diff line number Diff line change
@@ -52,10 +52,33 @@

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.

### Implementations


Check failure on line 57 in patterns/2-structured/innersource-portal.md

GitHub Actions / lint

Multiple consecutive blank lines [Expected: 1; Actual: 2]

Check failure on line 57 in patterns/2-structured/innersource-portal.md

GitHub Actions / lint

Multiple consecutive blank lines [Expected: 1; Actual: 2]
spier marked this conversation as resolved.
Show resolved Hide resolved
#### SAP Project Portal

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.

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

#### Wiki
spier marked this conversation as resolved.
Show resolved Hide resolved

As a simple way to start, you can set aside a page on an internal wiki for listing out available projects.
An easy way to display this information is in a table with columns giving just a little bit of extra information about the projects.
Try to have just enough columns so that viewers can determine if they want to learn more about the project, but no more.
Too much information will make the page overwhelming and difficult to use.

Here is a sample set of columns:

* **Name**. Name of the project (optionally linked to its homepage).
* **Brief Description**.
rrrutledge marked this conversation as resolved.
Show resolved Hide resolved
* **Technology Pre-requisites**. You must use these technologies in order to on-board to the project.
* **Getting Started**. Link to instructions on how to start using the project.
* **Chat**. Link to a chat channel to ask questions about the project.
* **Sponsoring Team**. Seeing if a team is behind the project can help others to have the confidence to use it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have seen "Maintaining Team" and "Host Team" for this in the ISC.

Is there a particular reason why you like "Sponsoring" better here?
e.g. are you worried that the "maintaining" emphasizes a notice of mine vs yours, and with that goes somewhat counter to the core idea of InnerSource?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to Host team. Yes - maintainer has some connotation that goes against parts of InnerSource.

* **Production Since**. How long as the project been used in a production environment? Seeing this information is a rough proxy for its maturity.
* **Contribution**. Link to instructions on how to contribute to the project.

## Resulting Context

* 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 +101,7 @@
* **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.
* **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.
* **Mercedes-Benz** is [using](https://opensource.mercedes-benz.com/news/sponsor_innersource_commonsoss) the SAP reference implementation mentioned above for their InnerSource Portal.
* **WellSky** has a simple _Confluence_ page were InnerSource and reusable projects are listed.
rrrutledge marked this conversation as resolved.
Show resolved Hide resolved

## References