From 96490023d0e3289582775742975188ff338b49ba Mon Sep 17 00:00:00 2001 From: nikimanoledaki Date: Fri, 28 Jun 2024 11:12:22 +0200 Subject: [PATCH] Move proposal 2 to docs/proposals --- .../proposals/diagrams}/calling-benchmark-job.png | Bin .../diagrams}/green-reviews-pipeline-components.png | Bin .../proposals/diagrams}/pipeline-run.png | Bin .../{files => diagrams}/trigger-deploy-pipeline.svg | 0 .../docs => docs}/proposals/proposal-002-run.md | 6 +++--- 5 files changed, 3 insertions(+), 3 deletions(-) rename {website/content/docs/proposals => docs/proposals/diagrams}/calling-benchmark-job.png (100%) rename {website/content/docs/proposals => docs/proposals/diagrams}/green-reviews-pipeline-components.png (100%) rename {website/content/docs/proposals => docs/proposals/diagrams}/pipeline-run.png (100%) rename docs/proposals/{files => diagrams}/trigger-deploy-pipeline.svg (100%) rename {website/content/docs => docs}/proposals/proposal-002-run.md (98%) diff --git a/website/content/docs/proposals/calling-benchmark-job.png b/docs/proposals/diagrams/calling-benchmark-job.png similarity index 100% rename from website/content/docs/proposals/calling-benchmark-job.png rename to docs/proposals/diagrams/calling-benchmark-job.png diff --git a/website/content/docs/proposals/green-reviews-pipeline-components.png b/docs/proposals/diagrams/green-reviews-pipeline-components.png similarity index 100% rename from website/content/docs/proposals/green-reviews-pipeline-components.png rename to docs/proposals/diagrams/green-reviews-pipeline-components.png diff --git a/website/content/docs/proposals/pipeline-run.png b/docs/proposals/diagrams/pipeline-run.png similarity index 100% rename from website/content/docs/proposals/pipeline-run.png rename to docs/proposals/diagrams/pipeline-run.png diff --git a/docs/proposals/files/trigger-deploy-pipeline.svg b/docs/proposals/diagrams/trigger-deploy-pipeline.svg similarity index 100% rename from docs/proposals/files/trigger-deploy-pipeline.svg rename to docs/proposals/diagrams/trigger-deploy-pipeline.svg diff --git a/website/content/docs/proposals/proposal-002-run.md b/docs/proposals/proposal-002-run.md similarity index 98% rename from website/content/docs/proposals/proposal-002-run.md rename to docs/proposals/proposal-002-run.md index 42946a8..8c8ad52 100644 --- a/website/content/docs/proposals/proposal-002-run.md +++ b/docs/proposals/proposal-002-run.md @@ -185,7 +185,7 @@ The Green Reviews automated pipeline relies on putting together different reusab There are different components defined here and shown in the following diagram. -![Green Reviews pipeline components](green-reviews-pipeline-components.png "Green Reviews pipeline components") +![Green Reviews pipeline components](diagrams/green-reviews-pipeline-components.png "Green Reviews pipeline components") 1. **Green Reviews pipeline**: the Continuous Integration pipeline which deploys a CNCF project to a test cluster, runs a set of benchmarks while measuring carbon emissions and stores the results. It is implemented by the workflows listed below. 2. **Cron workflow**: This refers to the initial GitHub Action workflow (described in proposal 1) and which dispatches a project workflow (see next definition). @@ -205,7 +205,7 @@ As a Job that calls another GitHub Action workflow (yes, yet another workflow The two options for defining a benchmark test are illustrated below. -![Calling the benchmark job](calling-benchmark-job.png "Calling the Benchmark job") +![Calling the benchmark job](diagrams/calling-benchmark-job.png "Calling the Benchmark job") ### Running & Defining Benchmark Jobs @@ -293,7 +293,7 @@ jobs: A Job can be fetched from other GitHub organizations and repositories using the `jobs..uses` syntax defined [here](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iduses). This syntax can be configured to use `@main` or `@another-branch` which would be nice for versioning and testing specific releases. -![Pipeline run](pipeline-run.png "An example pipeline run") +![Pipeline run](diagrams/pipeline-run.png "An example pipeline run")