https://github.com/rmarting/innersource-for-newbies
Do you want to learn about InnerSource? This is your place.
https://github.com/rmarting/innersource-for-newbies
innersource
Last synced: 4 months ago
JSON representation
Do you want to learn about InnerSource? This is your place.
- Host: GitHub
- URL: https://github.com/rmarting/innersource-for-newbies
- Owner: rmarting
- License: cc-by-sa-4.0
- Created: 2025-07-14T12:45:05.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-29T06:54:46.000Z (11 months ago)
- Last Synced: 2025-10-30T14:35:41.569Z (7 months ago)
- Topics: innersource
- Language: Dockerfile
- Homepage: https://blog.jromanmartin.io/innersource-for-newbies/#/
- Size: 844 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🏡 InnerSource for Newbies 🤷♂️
[](./docs/CODE_OF_CONDUCT.md)
[](https://github.com/rmarting/innersource-for-newbies/actions/workflows/markdown-lint.yml)
[](https://github.com/rmarting/innersource-for-newbies/actions/workflows/commit-lint.yml)
[](https://github.com/rmarting/innersource-for-newbies/actions/workflows/publish-release.yml)
## 🌟 Mission
Do you know anything about InnerSource? Or are you newbie in this space?
The mission of this repository is to serve as a comprehensive resource for individuals new to InnerSource concepts.
We aim to provide a clear and accessible introduction to the principles, patterns, and practices of InnerSource
collaboration. Our goal is to empower beginners to understand the fundamentals of InnerSource,
its relevance in modern software development environments, and the benefits it offers.
We welcome contributions that enhance clarity, expand content coverage, and offer practical insights
to support newcomers on their journey to mastering InnerSource methodologies.
## 🏁 Getting Started
This repository was created on top of two amazing frameworks to publish content easily:
* [docsify](https://docsify.js.org/) - Building the main content site
* [reveal.js](https://revealjs.com/) - Presenting professional content
The content of this site is located at [docs](./docs/) folder following the standard configuration of both frameworks.
To start locally your own server and serve the content:
```shell
npm install -g docsify-cli@latest
docsify serve docs
```
The content will be available at [http://localhost:3000](http://localhost:3000).
## 🛈 Further information
The content is mostly created using [Markdown](https://www.markdownguide.org/) syntax, so you do not need
to use HTML, JavaScript or other languages to prepare the content of this site. Easy, right? There is some
rules followed to maintain an standard structure and layout of the markdown files, please, take a look
of [them](https://github.com/DavidAnson/markdownlint/tree/main?tab=readme-ov-file#rules--aliases). There
is linter to verify that everything is ok.
**docsify** is used to generate the main structure of the content, including a sidebar with links to the
main sections, and **reveal.js** is used to create slides for some topics linked from the main site. Both
frameworks are integrated creating an unique experience for the reader improving the quality of the learning
and presenting the content easily and usefully for anyone.
Upgrading the frameworks to the latest versions should be done following the official documentation.
## 🆘 Getting help
If you are in troubles, do not worry, we are an InnerSource community that means that we are here
to support you. Please, open an issue describing your issue and we will take care of it.
## ⛙ Getting Involved
**Want to contribute?** Great! We try to make it easy, and all contributions, even
the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples...
But first, read our [Contribution Guide](./docs/CONTRIBUTING.md).
We are interested in building the community; we would welcome any thoughts or patches. You can
reach us on by our [communication channels](./docs/CONTACT.md).
## 📍 Releases
This project follows the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) to release
versions of this repository. The [changelog](./CHANGELOG.md) file contains a curated,
chronologically ordered list of notable changes for each version of this project.
Realising a new version only requires to push a new tag following the
`v[0-9]+.[0-9]+.[0-9]+` pattern (e.g: `v0.1.0`, `v0.1.1`...).
The [publish-release.yml](.github/workflows/publish-release.yml) workflow manages the release life cycle based on the
commits pushed into the repository. Based on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
the workflow will create a new major release including new features (`feat:`),
or a minor release fixing issues (`fix:`). This workflow is based on [Release Please](https://github.com/googleapis/release-please)
to automate the creation of the release, including the update of the [`ChangeLog`](./CHANGELOG.md) file.
## Publishing content
The content of this repo is designed to be published easily using capabilities as [GitHub Pages](https://pages.github.com/).
In the case those capabilities are not available, there is a [`Containerfile`](./Containerfile)
to build an image and deploy that image as an application in any container orchestrator such
as [Kubernetes](https://kubernetes.io/) or [Red Hat OpenShift](https://developers.redhat.com/products/openshift/overview).
## Using this content internally
This is a repository that it can be used as a template, just download it as a zip file and integrate into your
internal infrastructure. Don't hesitate to contact us to get help or support.