This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Assess your current state

Assess the maturity of your continuous delivery in your organization.

Information in this section helps your user try your project themselves.

  • What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.

  • Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.

Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.

Prerequisites

Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed?

Installation

Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?

Setup

Is there any initial setup users need to do after installation to try your project?

Try it out!

Can your users test their installation, for example by running a command or deploying a Hello World example?

1 - Value stream mapping

An approach to identifying waste and bottlenecks in current processes so that you can work to improve the way your teams work.

Value stream mapping is a tool for documenting end-to-end process across an organization and identifying what needs to change.

Add more info and resources

2 - DevOps capabilities

An approach to identifying waste and bottlenecks in current processes so that you can work to improve the way your teams work.

Stuff about DevOps Research and Assessment (DORA)

3 - Software supply chain security

An approach to identifying waste and bottlenecks in current processes so that you can work to improve the way your teams work.

Software we all build and use has many dependencies, including internal dependencies, third-party vendor software, and open source software. And each dependency has its own chain of dependencies.

We also need to trust the software tools and infrastructure we use to develop, build, store, and run software. And we need to trust that members of our teams are following secure practices.

As a result, there are many places where a software supply chain can be vulnerable to attacks.

Supply-chain Levels for Software Artifacts is a framework for assessing and improving the security and integrity of your software supply chain. It maps best practices as requirements for each defined level of security maturity.