From 53e996ddce6dd43766b226fbab8bbdd17f17a4f5 Mon Sep 17 00:00:00 2001 From: Lukas Rothenberger Date: Mon, 8 Jan 2024 17:03:41 +0100 Subject: [PATCH] doc(wiki): deprecated old pages --- .github/workflows/update_wiki.yml | 50 ++++++++++++++++++ ...Background.md => DEPRECATED_Background.md} | 0 .../Manual_Example.md | 0 .../Manual_Setup.md | 0 .../Quickstart.md | 0 .../DiscoPoP_Explorer.md | 0 .../Pattern_Detection.md | 0 .../Patterns/Do-All.md | 0 .../Patterns/Geometric_Decomposition.md | 0 .../Patterns/Patterns.md | 0 .../Patterns/Pipeline.md | 0 .../Patterns/Reduction.md | 0 .../Patterns/Tasks.md | 0 .../Data_Details.md | 0 .../File_Mapping.md | 0 .../Profiling.md | 0 .../Wrapper_Scripts.md | 0 ...Quickstart.md => DEPRECATED_Quickstart.md} | 0 ...Make.md => DEPRECATED_Quickstart_CMake.md} | 0 .../Configuration_Wizard.md | 0 .../Execution_Wizard.md | 0 .../Manual.md | 0 .../Tutorials.md | 0 docs/{img => DEPRECATED_img}/DPWorkflow.svg | 0 .../discoPoP_RGB_no_border.svg | Bin docs/{img => DEPRECATED_img}/init1.svg | 0 .../quickstart_example_1.png | Bin .../quickstart_example_2.png | Bin docs/{img => DEPRECATED_img}/reduction1.svg | 0 .../wizard_add_configuration.png | Bin .../wizard_build_folder_prompt.png | Bin .../wizard_detailed_view.png | Bin .../wizard_docker_prompt.png | Bin .../wizard_execution_configuration_screen.png | Bin .../wizard_go_bin_prompt.png | Bin .../wizard_initial_setup.png | Bin .../wizard_main_menu.png | Bin .../wizard_results_screen.png | Bin 38 files changed, 50 insertions(+) create mode 100644 .github/workflows/update_wiki.yml rename docs/{Background.md => DEPRECATED_Background.md} (100%) rename docs/{Manual_Quickstart => DEPRECATED_Manual_Quickstart}/Manual_Example.md (100%) rename docs/{Manual_Quickstart => DEPRECATED_Manual_Quickstart}/Manual_Setup.md (100%) rename docs/{Manual_Quickstart => DEPRECATED_Manual_Quickstart}/Quickstart.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/DiscoPoP_Explorer.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/Pattern_Detection.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/Patterns/Do-All.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/Patterns/Geometric_Decomposition.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/Patterns/Patterns.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/Patterns/Pipeline.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/Patterns/Reduction.md (100%) rename docs/{Pattern_Detection => DEPRECATED_Pattern_Detection}/Patterns/Tasks.md (100%) rename docs/{Profiling => DEPRECATED_Profiling}/Data_Details.md (100%) rename docs/{Profiling => DEPRECATED_Profiling}/File_Mapping.md (100%) rename docs/{Profiling => DEPRECATED_Profiling}/Profiling.md (100%) rename docs/{Profiling => DEPRECATED_Profiling}/Wrapper_Scripts.md (100%) rename docs/{Quickstart.md => DEPRECATED_Quickstart.md} (100%) rename docs/{Quickstart_CMake.md => DEPRECATED_Quickstart_CMake.md} (100%) rename docs/{Tutorials => DEPRECATED_Tutorials}/Configuration_Wizard.md (100%) rename docs/{Tutorials => DEPRECATED_Tutorials}/Execution_Wizard.md (100%) rename docs/{Tutorials => DEPRECATED_Tutorials}/Manual.md (100%) rename docs/{Tutorials => DEPRECATED_Tutorials}/Tutorials.md (100%) rename docs/{img => DEPRECATED_img}/DPWorkflow.svg (100%) rename docs/{img => DEPRECATED_img}/discoPoP_RGB_no_border.svg (100%) rename docs/{img => DEPRECATED_img}/init1.svg (100%) rename docs/{img => DEPRECATED_img}/quickstart_example_1.png (100%) rename docs/{img => DEPRECATED_img}/quickstart_example_2.png (100%) rename docs/{img => DEPRECATED_img}/reduction1.svg (100%) rename docs/{img => DEPRECATED_img}/wizard_add_configuration.png (100%) rename docs/{img => DEPRECATED_img}/wizard_build_folder_prompt.png (100%) rename docs/{img => DEPRECATED_img}/wizard_detailed_view.png (100%) rename docs/{img => DEPRECATED_img}/wizard_docker_prompt.png (100%) rename docs/{img => DEPRECATED_img}/wizard_execution_configuration_screen.png (100%) rename docs/{img => DEPRECATED_img}/wizard_go_bin_prompt.png (100%) rename docs/{img => DEPRECATED_img}/wizard_initial_setup.png (100%) rename docs/{img => DEPRECATED_img}/wizard_main_menu.png (100%) rename docs/{img => DEPRECATED_img}/wizard_results_screen.png (100%) diff --git a/.github/workflows/update_wiki.yml b/.github/workflows/update_wiki.yml new file mode 100644 index 000000000..7fce3f092 --- /dev/null +++ b/.github/workflows/update_wiki.yml @@ -0,0 +1,50 @@ +# This file is part of the DiscoPoP software (http://www.discopop.tu-darmstadt.de) +# +# Copyright (c) 2020, Technische Universitaet Darmstadt, Germany +# +# This software may be modified and distributed under the terms of +# the 3-Clause BSD License. See the LICENSE file in the package base +# directory for details. + +name: "DiscoPoP CI" +on: + push: + branches: + - update_wiki + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +jobs: + update_wiki-build: + name: "Update Wiki - Build" + runs-on: ubuntu-20.04 + if: github.ref == 'refs/heads/update_wiki' + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Pages + uses: actions/configure-pages@v2 + - name: Build with Jekyll + uses: actions/jekyll-build-pages@v1 + with: + source: ./docs/ + destination: ./_site + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + + update_wiki-deploy: + name: "Update Wiki - Deploy" + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-20.04 + needs: update_wiki-build + if: github.ref == 'refs/heads/update_wiki' + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/docs/Background.md b/docs/DEPRECATED_Background.md similarity index 100% rename from docs/Background.md rename to docs/DEPRECATED_Background.md diff --git a/docs/Manual_Quickstart/Manual_Example.md b/docs/DEPRECATED_Manual_Quickstart/Manual_Example.md similarity index 100% rename from docs/Manual_Quickstart/Manual_Example.md rename to docs/DEPRECATED_Manual_Quickstart/Manual_Example.md diff --git a/docs/Manual_Quickstart/Manual_Setup.md b/docs/DEPRECATED_Manual_Quickstart/Manual_Setup.md similarity index 100% rename from docs/Manual_Quickstart/Manual_Setup.md rename to docs/DEPRECATED_Manual_Quickstart/Manual_Setup.md diff --git a/docs/Manual_Quickstart/Quickstart.md b/docs/DEPRECATED_Manual_Quickstart/Quickstart.md similarity index 100% rename from docs/Manual_Quickstart/Quickstart.md rename to docs/DEPRECATED_Manual_Quickstart/Quickstart.md diff --git a/docs/Pattern_Detection/DiscoPoP_Explorer.md b/docs/DEPRECATED_Pattern_Detection/DiscoPoP_Explorer.md similarity index 100% rename from docs/Pattern_Detection/DiscoPoP_Explorer.md rename to docs/DEPRECATED_Pattern_Detection/DiscoPoP_Explorer.md diff --git a/docs/Pattern_Detection/Pattern_Detection.md b/docs/DEPRECATED_Pattern_Detection/Pattern_Detection.md similarity index 100% rename from docs/Pattern_Detection/Pattern_Detection.md rename to docs/DEPRECATED_Pattern_Detection/Pattern_Detection.md diff --git a/docs/Pattern_Detection/Patterns/Do-All.md b/docs/DEPRECATED_Pattern_Detection/Patterns/Do-All.md similarity index 100% rename from docs/Pattern_Detection/Patterns/Do-All.md rename to docs/DEPRECATED_Pattern_Detection/Patterns/Do-All.md diff --git a/docs/Pattern_Detection/Patterns/Geometric_Decomposition.md b/docs/DEPRECATED_Pattern_Detection/Patterns/Geometric_Decomposition.md similarity index 100% rename from docs/Pattern_Detection/Patterns/Geometric_Decomposition.md rename to docs/DEPRECATED_Pattern_Detection/Patterns/Geometric_Decomposition.md diff --git a/docs/Pattern_Detection/Patterns/Patterns.md b/docs/DEPRECATED_Pattern_Detection/Patterns/Patterns.md similarity index 100% rename from docs/Pattern_Detection/Patterns/Patterns.md rename to docs/DEPRECATED_Pattern_Detection/Patterns/Patterns.md diff --git a/docs/Pattern_Detection/Patterns/Pipeline.md b/docs/DEPRECATED_Pattern_Detection/Patterns/Pipeline.md similarity index 100% rename from docs/Pattern_Detection/Patterns/Pipeline.md rename to docs/DEPRECATED_Pattern_Detection/Patterns/Pipeline.md diff --git a/docs/Pattern_Detection/Patterns/Reduction.md b/docs/DEPRECATED_Pattern_Detection/Patterns/Reduction.md similarity index 100% rename from docs/Pattern_Detection/Patterns/Reduction.md rename to docs/DEPRECATED_Pattern_Detection/Patterns/Reduction.md diff --git a/docs/Pattern_Detection/Patterns/Tasks.md b/docs/DEPRECATED_Pattern_Detection/Patterns/Tasks.md similarity index 100% rename from docs/Pattern_Detection/Patterns/Tasks.md rename to docs/DEPRECATED_Pattern_Detection/Patterns/Tasks.md diff --git a/docs/Profiling/Data_Details.md b/docs/DEPRECATED_Profiling/Data_Details.md similarity index 100% rename from docs/Profiling/Data_Details.md rename to docs/DEPRECATED_Profiling/Data_Details.md diff --git a/docs/Profiling/File_Mapping.md b/docs/DEPRECATED_Profiling/File_Mapping.md similarity index 100% rename from docs/Profiling/File_Mapping.md rename to docs/DEPRECATED_Profiling/File_Mapping.md diff --git a/docs/Profiling/Profiling.md b/docs/DEPRECATED_Profiling/Profiling.md similarity index 100% rename from docs/Profiling/Profiling.md rename to docs/DEPRECATED_Profiling/Profiling.md diff --git a/docs/Profiling/Wrapper_Scripts.md b/docs/DEPRECATED_Profiling/Wrapper_Scripts.md similarity index 100% rename from docs/Profiling/Wrapper_Scripts.md rename to docs/DEPRECATED_Profiling/Wrapper_Scripts.md diff --git a/docs/Quickstart.md b/docs/DEPRECATED_Quickstart.md similarity index 100% rename from docs/Quickstart.md rename to docs/DEPRECATED_Quickstart.md diff --git a/docs/Quickstart_CMake.md b/docs/DEPRECATED_Quickstart_CMake.md similarity index 100% rename from docs/Quickstart_CMake.md rename to docs/DEPRECATED_Quickstart_CMake.md diff --git a/docs/Tutorials/Configuration_Wizard.md b/docs/DEPRECATED_Tutorials/Configuration_Wizard.md similarity index 100% rename from docs/Tutorials/Configuration_Wizard.md rename to docs/DEPRECATED_Tutorials/Configuration_Wizard.md diff --git a/docs/Tutorials/Execution_Wizard.md b/docs/DEPRECATED_Tutorials/Execution_Wizard.md similarity index 100% rename from docs/Tutorials/Execution_Wizard.md rename to docs/DEPRECATED_Tutorials/Execution_Wizard.md diff --git a/docs/Tutorials/Manual.md b/docs/DEPRECATED_Tutorials/Manual.md similarity index 100% rename from docs/Tutorials/Manual.md rename to docs/DEPRECATED_Tutorials/Manual.md diff --git a/docs/Tutorials/Tutorials.md b/docs/DEPRECATED_Tutorials/Tutorials.md similarity index 100% rename from docs/Tutorials/Tutorials.md rename to docs/DEPRECATED_Tutorials/Tutorials.md diff --git a/docs/img/DPWorkflow.svg b/docs/DEPRECATED_img/DPWorkflow.svg similarity index 100% rename from docs/img/DPWorkflow.svg rename to docs/DEPRECATED_img/DPWorkflow.svg diff --git a/docs/img/discoPoP_RGB_no_border.svg b/docs/DEPRECATED_img/discoPoP_RGB_no_border.svg similarity index 100% rename from docs/img/discoPoP_RGB_no_border.svg rename to docs/DEPRECATED_img/discoPoP_RGB_no_border.svg diff --git a/docs/img/init1.svg b/docs/DEPRECATED_img/init1.svg similarity index 100% rename from docs/img/init1.svg rename to docs/DEPRECATED_img/init1.svg diff --git a/docs/img/quickstart_example_1.png b/docs/DEPRECATED_img/quickstart_example_1.png similarity index 100% rename from docs/img/quickstart_example_1.png rename to docs/DEPRECATED_img/quickstart_example_1.png diff --git a/docs/img/quickstart_example_2.png b/docs/DEPRECATED_img/quickstart_example_2.png similarity index 100% rename from docs/img/quickstart_example_2.png rename to docs/DEPRECATED_img/quickstart_example_2.png diff --git a/docs/img/reduction1.svg b/docs/DEPRECATED_img/reduction1.svg similarity index 100% rename from docs/img/reduction1.svg rename to docs/DEPRECATED_img/reduction1.svg diff --git a/docs/img/wizard_add_configuration.png b/docs/DEPRECATED_img/wizard_add_configuration.png similarity index 100% rename from docs/img/wizard_add_configuration.png rename to docs/DEPRECATED_img/wizard_add_configuration.png diff --git a/docs/img/wizard_build_folder_prompt.png b/docs/DEPRECATED_img/wizard_build_folder_prompt.png similarity index 100% rename from docs/img/wizard_build_folder_prompt.png rename to docs/DEPRECATED_img/wizard_build_folder_prompt.png diff --git a/docs/img/wizard_detailed_view.png b/docs/DEPRECATED_img/wizard_detailed_view.png similarity index 100% rename from docs/img/wizard_detailed_view.png rename to docs/DEPRECATED_img/wizard_detailed_view.png diff --git a/docs/img/wizard_docker_prompt.png b/docs/DEPRECATED_img/wizard_docker_prompt.png similarity index 100% rename from docs/img/wizard_docker_prompt.png rename to docs/DEPRECATED_img/wizard_docker_prompt.png diff --git a/docs/img/wizard_execution_configuration_screen.png b/docs/DEPRECATED_img/wizard_execution_configuration_screen.png similarity index 100% rename from docs/img/wizard_execution_configuration_screen.png rename to docs/DEPRECATED_img/wizard_execution_configuration_screen.png diff --git a/docs/img/wizard_go_bin_prompt.png b/docs/DEPRECATED_img/wizard_go_bin_prompt.png similarity index 100% rename from docs/img/wizard_go_bin_prompt.png rename to docs/DEPRECATED_img/wizard_go_bin_prompt.png diff --git a/docs/img/wizard_initial_setup.png b/docs/DEPRECATED_img/wizard_initial_setup.png similarity index 100% rename from docs/img/wizard_initial_setup.png rename to docs/DEPRECATED_img/wizard_initial_setup.png diff --git a/docs/img/wizard_main_menu.png b/docs/DEPRECATED_img/wizard_main_menu.png similarity index 100% rename from docs/img/wizard_main_menu.png rename to docs/DEPRECATED_img/wizard_main_menu.png diff --git a/docs/img/wizard_results_screen.png b/docs/DEPRECATED_img/wizard_results_screen.png similarity index 100% rename from docs/img/wizard_results_screen.png rename to docs/DEPRECATED_img/wizard_results_screen.png