From 70d2b7fbc8c56c6f0c93610c853ed2679ad1a5ba Mon Sep 17 00:00:00 2001 From: Marco De Benedictis Date: Wed, 16 Oct 2024 11:32:23 +0200 Subject: [PATCH] chore: remove unused files Signed-off-by: Marco De Benedictis --- .conform.yaml | 24 ------ .dockerignore | 8 -- .editorconfig | 26 ------ .gcloudignore | 6 -- .hadolint.yaml | 4 - .yamllint.yaml | 13 --- CHANGELOG.md | 14 ---- CONTRIBUTING.md | 135 -------------------------------- DECISIONS.md | 42 ---------- Dockerfile | 8 -- Makefile | 89 --------------------- ROADMAP.md | 11 --- docs/explanation/index.md | 1 - docs/how-to/diagrams-as-code.md | 58 -------------- docs/how-to/mkdocs.md | 23 ------ docs/index.md | 1 - docs/reference/index.md | 1 - docs/tutorials/index.md | 1 - mkdocs.yml | 31 -------- requirements.txt | 30 ------- 20 files changed, 526 deletions(-) delete mode 100644 .conform.yaml delete mode 100644 .dockerignore delete mode 100644 .editorconfig delete mode 100644 .gcloudignore delete mode 100644 .hadolint.yaml delete mode 100644 .yamllint.yaml delete mode 100644 CHANGELOG.md delete mode 100644 CONTRIBUTING.md delete mode 100644 DECISIONS.md delete mode 100644 Dockerfile delete mode 100644 Makefile delete mode 100644 ROADMAP.md delete mode 100644 docs/explanation/index.md delete mode 100644 docs/how-to/diagrams-as-code.md delete mode 100644 docs/how-to/mkdocs.md delete mode 100644 docs/index.md delete mode 100644 docs/reference/index.md delete mode 100644 docs/tutorials/index.md delete mode 100644 mkdocs.yml delete mode 100644 requirements.txt diff --git a/.conform.yaml b/.conform.yaml deleted file mode 100644 index 4d85670..0000000 --- a/.conform.yaml +++ /dev/null @@ -1,24 +0,0 @@ ---- -policies: - - type: commit - spec: - header: - length: 89 - imperative: true - case: lower - invalidLastCharacters: . - body: - required: true - dco: false - gpg: true - spellcheck: - locale: GB - conventional: - types: - - chore - - docs - - feat - - refactor - - style - - fix - - test diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index 4aee51a..0000000 --- a/.dockerignore +++ /dev/null @@ -1,8 +0,0 @@ -Dockerfile* -Jenkinsfile* -**/.terraform -.git/ - -.idea/ -*.iml -.gcloudignore diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index f0f6f00..0000000 --- a/.editorconfig +++ /dev/null @@ -1,26 +0,0 @@ -root = true - -[*] -end_of_line = lf -indent_style = space -indent_size = 2 -insert_final_newline = true -max_line_length = 120 -trim_trailing_whitespace = true - -[*.py] -indent_size = 4 - -[{Makefile,makefile,**.mk}] -indent_style = tab - -[*.sh] -indent_style = space -indent_size = 2 - -shell_variant = bash # like -ln=posix -binary_next_line = true # like -bn -switch_case_indent = true # like -ci -space_redirects = true # like -sr -keep_padding = false # like -kp - diff --git a/.gcloudignore b/.gcloudignore deleted file mode 100644 index 3f2a56c..0000000 --- a/.gcloudignore +++ /dev/null @@ -1,6 +0,0 @@ -.gcloudignore -# If you would like to upload your .git directory, .gitignore file or -# files from your .gitignore file, remove the corresponding line below: -.git -.gitignore -#!include:.dockerignore diff --git a/.hadolint.yaml b/.hadolint.yaml deleted file mode 100644 index 7e0da6e..0000000 --- a/.hadolint.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -ignored: - - DL3018 # Pin versions in apk add. - - DL3022 # COPY --from alias diff --git a/.yamllint.yaml b/.yamllint.yaml deleted file mode 100644 index 5dd5ef4..0000000 --- a/.yamllint.yaml +++ /dev/null @@ -1,13 +0,0 @@ ---- -extends: default - -ignore: | - test/bin/ - test/asset/ -rules: - comments: - min-spaces-from-content: 1 - line-length: - max: 120 - truthy: - check-keys: false diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 701bbef..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,14 +0,0 @@ -## Version (0.0.0) -### Releshed/Unreleased -### Date - -Changes: -- List of changes - -Improvements: -- List of improvements - -Bug Fixes: -- NA - ---- \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index e00fab1..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,135 +0,0 @@ -# Contributing to Control Plane - -:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: - -Control Plane use the Apache 2.0 licence and accepts contributions via GitHub pull requests. - -The following is a set of guidelines for contributing to a Control Plane project. We generally have stricter rules as we focus on security but don't let that discourage you from creating your PR, it can be incrementally fixed to fit the rules. Also feel free to propose changes to this document in a pull request. - -## Table Of Contents - -- [Contributing to Control Plane](#contributing-to-control-plane) - - [Table Of Contents](#table-of-contents) - - [How Can I Contribute?](#how-can-i-contribute) - - [Reporting Bugs](#reporting-bugs) - - [Before Submitting a Bug Report](#before-submitting-a-bug-report) - - [How Do I Submit a (Good) Bug Report?](#how-do-i-submit-a-good-bug-report) - - [Suggesting Enhancements](#suggesting-enhancements) - - [Before Submitting an Enhancement Suggestion](#before-submitting-an-enhancement-suggestion) - - [How Do I Submit A (Good) Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion) - - [Your First Code Contribution](#your-first-code-contribution) - - [Development](#development) - - [Pull Requests](#pull-requests) - - [Style Guides](#style-guides) - - [Git Commit Messages](#git-commit-messages) - ---- - -## How Can I Contribute? - -### Reporting Bugs - -This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report, reproduce the behaviour, and find related reports. - -Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out the issue template for bugs, the information it asks for helps us resolve issues faster. - -> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue -> and include a link to the original issue in the body of your new one. -#### Before Submitting a Bug Report - -- **Perform a cursory search** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one - -#### How Do I Submit a (Good) Bug Report? - -Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). -Create an issue on within the repository and provide the following information by filling in the issue template. - -Explain the problem and include additional details to help maintainers reproduce the problem: - -- **Use a clear and descriptive title** for the issue to identify the problem -- **Describe the exact steps which reproduce the problem** in as many details as possible. -- **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour -- **Explain which behaviour you expected to see instead and why.** - -Provide more context by answering these questions: - -- **Did the problem start happening recently** or was this always a problem? -- If the problem started happening recently, **can you reproduce the problem in an older version/release of the Training Infrastructure?** What's the most recent version in which the problem doesn't happen? -- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens - -### Suggesting Enhancements - -This section guides you through submitting an enhancement suggestion for Training Infrastructure, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers understand your suggestion and find related suggestions. - -Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in the template feature request template, including the steps that you imagine you would take if the feature you're requesting existed. - -#### Before Submitting an Enhancement Suggestion - -- **Check if there's already a covering enhancement** -- **Perform a cursory search** to see if the enhancement has - already been suggested. If it has, add a comment to the existing issue instead of opening a new one - -#### How Do I Submit A (Good) Enhancement Suggestion? - -Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Make sure to provide the following information: - -- **Use a clear and descriptive title** for the issue to identify the suggestion -- **Provide a step-by-step description of the suggested enhancement** in as many details as possible -- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, - as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines) -- **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why -- **Explain why this enhancement would be useful** to most Kubesec users and isn't something that can or should be implemented - as a separate community project -- **List some other tools where this enhancement exists.** -- **Specify which version of Kubesec you're using.** You can get the exact version by running `kubesec version` in your terminal -- **Specify the name and version of the OS you're using.** - -### Your First Code Contribution - -Unsure where to begin contributing to the Training infrastructure? You can start by looking through these `Good First Issue` and `Help Wanted` -issues: - -- [Good First Issue issues][good_first_issue] - issues which should only require a few lines of code, and a test or two -- [Help wanted issues][help_wanted] - issues which should be a bit more involved than `Good First Issue` issues - -Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have. - -#### Development - -- TBC - -### Pull Requests - -The process described here has several goals: - -- Maintain training quality -- Fix problems that are important to the training team and users -- Enable a sustainable system for training maintainers to review contributions - -Please follow these steps to have your contribution considered by the maintainers: - -1. Follow all instructions in the template -2. Follow the [style guides](#style-guides) -3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) - are passing -
- What if the status checks are failing? - If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on - the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for - you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our - status check suite. -
- - -While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional tests, or other changes before your pull request can be ultimately accepted. - -## Style Guides - -### Git Commit Messages - -- It's strongly preferred you [GPG Verify][commit_signing] your commits if you can -- Follow [Conventional Commits](https://www.conventionalcommits.org) -- Use the present tense ("add feature" not "added feature") -- Use the imperative mood ("move cursor to..." not "moves cursor to...") -- Limit the first line to 72 characters or less -- Reference issues and pull requests liberally after the first line diff --git a/DECISIONS.md b/DECISIONS.md deleted file mode 100644 index a9ecd26..0000000 --- a/DECISIONS.md +++ /dev/null @@ -1,42 +0,0 @@ -// Example taken from https://github.com/eclipse/winery/blob/master/docs/adr/0027-use-dasherization-for-filenames.md - -# Use dasherization for filenames - -## Context and Problem Statement - -Graphics files have to take a consistent file name - -## Decision Drivers - -* Easy to process by Jekyll -* No WTFs at the creators - -## Considered Options - -* [Dasherization](https://softwareengineering.stackexchange.com/a/104476/52607) (e.g., `architecture-bpmn4tosca.png`) -* Camel Case (e.g., `ArchitectureBPMN4TOSCA.png`) - -## Decision Outcome - -Chosen option: "Dasherization", because - -* clear separation of parts of the name -* consistent to other URLs (which are typically lowercase) - -## Links - -* GADR: https://github.com/adr/gadr-misc/blob/master/gadr--filename-convention.md - -## License - -Copyright (c) 2018 Contributors to the Eclipse Foundation - -See the NOTICE file(s) distributed with this work for additional -information regarding copyright ownership. - -This program and the accompanying materials are made available under the -terms of the Eclipse Public License 2.0 which is available at -http://www.eclipse.org/legal/epl-2.0, or the Apache Software License 2.0 -which is available at https://www.apache.org/licenses/LICENSE-2.0. - -SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 \ No newline at end of file diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index f4da5c2..0000000 --- a/Dockerfile +++ /dev/null @@ -1,8 +0,0 @@ -FROM debian:buster - -RUN \ - DEBIAN_FRONTEND=noninteractive \ - apt update && apt install --assume-yes --no-install-recommends \ - bash \ - \ - && rm -rf /var/lib/apt/lists/* diff --git a/Makefile b/Makefile deleted file mode 100644 index e70de53..0000000 --- a/Makefile +++ /dev/null @@ -1,89 +0,0 @@ -NAME := hamlet-vase-service -GITHUB_ORG := controlplaneio -DOCKER_HUB_ORG := controlplane - -### github.com/controlplaneio/ensure-content.git makefile-header START ### -ifeq ($(NAME),) - $(error NAME required, please add "NAME := project-name" to top of Makefile) -else ifeq ($(GITHUB_ORG),) - $(error GITHUB_ORG required, please add "GITHUB_ORG := controlplaneio" to top of Makefile) -else ifeq ($(DOCKER_HUB_ORG),) - $(error DOCKER_HUB_ORG required, please add "DOCKER_HUB_ORG := controlplane" to top of Makefile) -endif - -PKG := github.com/$(GITHUB_ORG)/$(NAME) -# TODO migrate to quay.io -CONTAINER_REGISTRY_FQDN ?= docker.io -CONTAINER_REGISTRY_URL := $(CONTAINER_REGISTRY_FQDN)/$(DOCKER_HUB_ORG)/$(NAME) - -SHELL := /bin/bash -BUILD_DATE := $(shell date -u +%Y-%m-%dT%H:%M:%SZ) - -GIT_MESSAGE := $(shell git -c log.showSignature=false \ - log --max-count=1 --pretty=format:"%H" 2>/dev/null) -GIT_SHA := $(shell git -c log.showSignature=false rev-parse HEAD 2>/dev/null) -GIT_TAG := $(shell bash -c 'TAG=$$(git -c log.showSignature=false \ - describe --tags --exact-match --abbrev=0 $(GIT_SHA) 2>/dev/null); echo "$${TAG:-dev}"') -GIT_UNTRACKED_CHANGES := $(shell git -c log.showSignature=false \ - status --porcelain 2>/dev/null) - -ifneq ($(GIT_UNTRACKED_CHANGES),) - GIT_COMMIT := $(GIT_COMMIT)-dirty - ifneq ($(GIT_TAG),dev) - GIT_TAG := $(GIT_TAG)-dirty - endif -endif - -CONTAINER_TAG ?= $(GIT_TAG) -CONTAINER_TAG_LATEST := $(CONTAINER_TAG) -CONTAINER_NAME := $(CONTAINER_REGISTRY_URL):$(CONTAINER_TAG) - -# if no untracked changes and tag is not dev, release `latest` tag -ifeq ($(GIT_UNTRACKED_CHANGES),) - ifneq ($(GIT_TAG),dev) - CONTAINER_TAG_LATEST = latest - endif -endif - -CONTAINER_NAME_LATEST := $(CONTAINER_REGISTRY_URL):$(CONTAINER_TAG_LATEST) - -# golang buildtime, more at https://github.com/jessfraz/pepper/blob/master/Makefile -CTIMEVAR=-X $(PKG)/version.GITCOMMIT=$(GITCOMMIT) -X $(PKG)/version.VERSION=$(VERSION) -GO_LDFLAGS=-ldflags "-w $(CTIMEVAR)" -GO_LDFLAGS_STATIC=-ldflags "-w $(CTIMEVAR) -extldflags -static" - -export NAME CONTAINER_REGISTRY_URL BUILD_DATE GIT_MESSAGE GIT_SHA GIT_TAG \ - CONTAINER_TAG CONTAINER_NAME CONTAINER_NAME_LATEST CONTAINER_NAME_TESTING -### github.com/controlplaneio/ensure-content.git makefile-header END ### - -.PHONY: all -.SILENT: - -all: help - -.PHONY: build -build: ## builds a docker image - @echo "+ $@" >&2 - docker build --tag "${CONTAINER_NAME}" . - -.PHONY: run -run: ## runs the last build docker image - @echo "+ $@" >&2 - docker run -it "${CONTAINER_NAME}" - -.PHONY: test -test: ## test the application - @echo "+ $@" >&2 - if [[ "$$(bats --count test/)" -lt 1 ]]; then echo 'No tests found' >&2; exit 1; fi - bats --recursive \ - --timing \ - --jobs 10 \ - test/ - -.PHONY: help -help: ## parse jobs and descriptions from this Makefile - @grep -E '^[ a-zA-Z0-9_-]+:([^=]|$$)' $(MAKEFILE_LIST) \ - | grep -Ev '^help\b[[:space:]]*:' \ - | sort \ - | awk 'BEGIN {FS = ":.*?##"}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' - diff --git a/ROADMAP.md b/ROADMAP.md deleted file mode 100644 index d496d0e..0000000 --- a/ROADMAP.md +++ /dev/null @@ -1,11 +0,0 @@ -# Training Infrastructure Roadmap - -This document covers the upcoming milestones for the training infrastructure project. - -
- -## Upcoming Milestone Dates - -| Milestone | Release Date | -|---------------------------|--------------| -| TBC | TBC | \ No newline at end of file diff --git a/docs/explanation/index.md b/docs/explanation/index.md deleted file mode 100644 index b1303b4..0000000 --- a/docs/explanation/index.md +++ /dev/null @@ -1 +0,0 @@ -# Explanation diff --git a/docs/how-to/diagrams-as-code.md b/docs/how-to/diagrams-as-code.md deleted file mode 100644 index 62594a8..0000000 --- a/docs/how-to/diagrams-as-code.md +++ /dev/null @@ -1,58 +0,0 @@ -# Diagrams as Code - -## Mermaid - -```mermaid -graph TD -A[Client] --> B[Load Balancer] -B --> C[Server01] -B --> D[Server02] -``` - -## Plant UML - -```puml -@startuml -title CP Theme -'skinparam handwritten true -skinparam { - ArrowColor Black - NoteColor Black - NoteBackgroundColor White - LifeLineBorderColor Black - LifeLineColor Black - ParticipantBorderColor Black - ParticipantBackgroundColor Black - ParticipantFontColor White - defaultFontStyle Bold -} - -== 1. title == - -"Dev Machine"->Github: commit and push -Github->Jenkins: call webhook,\ntrigger build - -Jenkins->"Build Slave": automated trigger:\ncommit - -== 2a. image scan == - -Jenkins->"Build Slave": automated trigger:\nimage scan -@enduml -``` - -## C4 Container Diagram - -See [Mermaid's C4 Syntax](https://mermaid.js.org/syntax/c4c.html) and -[C4 Plant UML](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md). - -```puml -@startuml C4_Elements -!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml - -Person(personAlias, "Label", "Optional Description") -Container(containerAlias, "Label", "Technology", "Optional Description") -System(systemAlias, "Label", "Optional Description") - -Rel(personAlias, containerAlias, "Label", "Optional Technology") -@enduml -``` diff --git a/docs/how-to/mkdocs.md b/docs/how-to/mkdocs.md deleted file mode 100644 index 528320f..0000000 --- a/docs/how-to/mkdocs.md +++ /dev/null @@ -1,23 +0,0 @@ -# MkDocs - -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - -See [Diataxis Framework](https://diataxis.fr/tutorials/) - - README.md # The documentation homepage. - mkdocs.yml # The configuration file. - docs/ - index.md # Includes README.md. - tutorials/ # Tutorials. - how-to/ # How to Guides - reference/ # Reference - explanation/ # Explanations diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 612c7a5..0000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ ---8<-- "README.md" diff --git a/docs/reference/index.md b/docs/reference/index.md deleted file mode 100644 index cf5aa07..0000000 --- a/docs/reference/index.md +++ /dev/null @@ -1 +0,0 @@ -# Reference diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md deleted file mode 100644 index 81c8590..0000000 --- a/docs/tutorials/index.md +++ /dev/null @@ -1 +0,0 @@ -# Tutorials diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 502bf03..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,31 +0,0 @@ -site_name: CP Repo Template -theme: - name: material -plugins: - - search - - mermaid2 - - plantuml: - puml_url: https://www.plantuml.com/plantuml/ - num_workers: 8 -markdown_extensions: - - admonition - - pymdownx.details - - pymdownx.superfences: - # make exceptions to highlighting of code: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:mermaid2.fence_mermaid - - pymdownx.snippets: - check_paths: true -nav: - - 'Home': 'index.md' - - Tutorials: - - Placeholder: tutorials/index.md - - How to Guides: - - MkDocs: how-to/mkdocs.md - - Diagrams as Code: how-to/diagrams-as-code.md - - Reference: - - Placeholder: reference/index.md - - Explanation: - - Placeholder: explanation/index.md diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index c279acc..0000000 --- a/requirements.txt +++ /dev/null @@ -1,30 +0,0 @@ -beautifulsoup4==4.11.1 -certifi==2022.12.7 -charset-normalizer==3.0.1 -click==8.1.3 -colorama==0.4.6 -EditorConfig==0.12.3 -ghp-import==2.1.0 -idna==3.4 -Jinja2==3.1.2 -jsbeautifier==1.14.7 -Markdown==3.3.7 -MarkupSafe==2.1.2 -mergedeep==1.3.4 -mkdocs==1.4.2 -mkdocs-material==9.0.7 -mkdocs-material-extensions==1.1.1 -mkdocs-mermaid2-plugin==0.6.0 -mkdocs_puml==1.1.0 -packaging==23.0 -Pygments==2.14.0 -pymdown-extensions==9.9.2 -python-dateutil==2.8.2 -PyYAML==6.0 -pyyaml_env_tag==0.1 -regex==2022.10.31 -requests==2.28.2 -six==1.16.0 -soupsieve==2.3.2.post1 -urllib3==1.26.14 -watchdog==2.2.1