Skip to content

Commit dcc05a2

Browse files
committed
docs/overview: Changed format of headers.
Signed-off-by: jaenrig-ifx <[email protected]>
1 parent ac7dc22 commit dcc05a2

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/overview/motivation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Background
1111

1212
The introduction of `arduino-cli <https://docs.arduino.cc/arduino-cli/>`_ has been a significant step forward in enabling programmatic handling of the Arduino toolchain and processes. This has opened up possibilities for automation via scripts and command line interfaces, making it easier to integrate tasks like build verification and testing into continuous integration servers.
1313

14-
Current State and Objectives
14+
Current state and objectives
1515
----------------------------
1616

1717
While existing DevOps solutions, such as `compile-sketches action <https://github.com/arduino/compile-sketches>`_, provide some functionality, they do not fully meet our requirements. This project aims to fill this gap by providing a collection of utilities that solve specific DevOps use cases for managing Arduino assets. The scope of this project is intentionally open-ended, allowing it to evolve and adapt to emerging needs.
1818

19-
Key Features and Design Principles
19+
Key features and design principles
2020
----------------------------------
2121

2222
The project's features are designed to be used via command line interface, making it easy to integrate with any non-GUI CI/CD framework and environment. Python is the language of choice, ensuring cross-platform compatibility. Although our primary development and testing platform is Linux, we strive to ensure platform independence.
@@ -25,7 +25,7 @@ When applicable, the features presented rely on the Arduino `platform <https://d
2525

2626
The solutions provided for CI/CD are implemented through GitHub Actions `reusable workflows <https://docs.github.com/en/actions/sharing-automations/reusing-workflows>`_. This allows for easy deployment and upgrading of workflows with minimal effort. Given GitHub's popularity among Arduino developers, we have chosen to focus on GitHub Actions initially. However, we believe it should be straightforward to port the workflows to other CI/CD frameworks, such as GitLab, Jenkins, or Travis.
2727

28-
Community Engagement and Contributions
28+
Community engagement and contributions
2929
--------------------------------------
3030

3131
We believe these tools can be of general interest and applicability to any Arduino library or core developer. We encourage users to try them out, provide feedback, and contribute to making them more extensible and adaptable to various use cases.

docs/overview/usage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ This repository is designed to automate DevOps processes for Arduino libraries a
55
Thus, we recommend starting by adding the available `reusable workflows <https://github.com/Infineon/arduino-devops/tree/main/.github/workflows>`_ to your GitHub-hosted library or core.
66
Before running the workflows, you'll need to configure them with some minimal settings.
77

8-
Step-by-Step Enablement
8+
Step-by-step enablement
99
-----------------------
1010

1111
To begin, we recommend following our Getting Started guides, which will walk you through the process of enabling the workflows:
1212

1313
- :ref:`Getting started with compile-examples <compile_examples_getting_started>` workflow enablement. Learn how to set up the compile-examples workflow and start automating your build processes.
1414
- :ref:`Getting started with release <release_getting_started>` workflow enablement. Discover how to enable the release workflow and streamline your library or core releases.
1515

16-
Advanced Customizations and Local Usage
16+
Advanced customizations and local usage
1717
---------------------------------------
1818

1919
As you become more familiar with the workflows and scripts, you might need advanced customizations to tailor them to your needs. You can also use the scripts locally on your development machine.
2020

21-
Running Scripts Locally
21+
Running scripts locally
2222
~~~~~~~~~~~~~~~~~~~~~~~
2323

2424
To run the scripts locally, first ensure you have the required dependencies installed (see :ref:`Requirements <requirements>`).

0 commit comments

Comments
 (0)