Overview

This manual is intended to be used by the infra community and staff when updating the roadmap. The roadmap reflects the quarterly cadences at which work is completed. Each quarter is tracked by an associated milestone on our GitLab Instance. The work inside each milestone is divided into four logical groups of work known as components (knowledge, trust, policy and tools). Each individual component is made up of clearly defined goals known as capabilities. These capabilities consist of issues tracked on the IEEE SA OPEN Platform.

Adding a new Capability

New capabilities represent new bodies of work to be undertaken by the IEEE SA OPEN Community. To propose a new Capability, contact the Project Manager with the answers to the following questions to get on the agenda:

• What is the name of the new capability?
• Is this a new or existing area of work?
• What areas of work does this capability specifically target

Adding a Capability to GitLab

If a Capability has been approved it can be added to the labels in the infra/roadmap project. The Capability Label should have the following syntax: “Capability: NAME” where NAME is the name of the capability. Example: The Community Data capabilities label would be named: “Capability: Community Data”

Adding a new Issue

New tickets should be added to the infra/roadmap issue tracker. New capabilities should include the following information:

• Title: Use a clear and concise description of the work to be completed
• Label: All issues must be labeled with the “Component” and “Capability” it is associated with it
  • Full list of current capabilities and components can be found on the components page
• Milestone: Select the milestone to indicate the Quarter the work is expected to be completed in

Adding a new Component

New components must be proposed at the Quarterly Infrastructure Team Planning Meeting. Due to the higher level nature of components the need to create new ones should be a rarity. It is preferable to create new Capabilities that add to an existing Component when possible. To propose a new high level component, contact the Project Manager with the answers to the following questions to get on the agenda:

• What is the name of the new component?
• Is this a new or existing area of work?
• What areas of work does this component specifically target

At the Planning Meeting new components will be approved and added to the roadmap, tabled for later evaluation, or declined.

Adding a Component to GitLab

If a Component has been approved it can be added to the labels in the infra project. The Component Label should have the following syntax: “Component: NAME” where NAME is the name of the component. Example: The knowledge component’s label would be named: “Component: Knowledge”

Auto-updating Roadmap

The Infrastructure roadmap is automatically maintained and updated by a GitLab webhook in conjunction with the GitLab Pages CI/CD Pipeline. The following two repositories are used for this process:

• infra/roadmap - Triggers a run of the infra/infra.ieee-saopen.org GitLab Pages Pipeline via a webhook any time a issue is created, updated, or closed in the infra/roadmap project on the platform.
• infra/infra.ieee-saopen.org - Hosts the infra microsite and updates the roadmap when the webhook is received. The roadmap is updated using the following python script: bin/update-roadmap.py