OWASP/wrongsecrets-ctf-party

Create documentation

Open

#79 opened on Oct 4, 2022

View on GitHub
 (9 comments) (0 reactions) (1 assignee)JavaScript (20 forks)github user discovery
help wanted

Repository metrics

Stars
 (55 stars)
PR merge metrics
 (PR metrics pending)

Description

Todos:

  • have github pages in place
  • have helm release process in place
  • Have supportive Docker release scripts in place (both tagged&latest)
  • cleanup the guides to be limited on what we actually have (k8s, Azure, GCP & AWS)
  • document the details required to run K8s
  • document the details required to run AWS
  • document the details required to run GCP
  • document the details required to run Azure
  • document CTFD setup (Automated and manual!)

Contributor guide

Research direction
Review the dependent issues (#86 and #453) to understand the context. Then, follow the checklist: set up GitHub Pages, implement Helm release process, create Docker release scripts, clean up guides, and document K8s, AWS, GCP, Azure, and CTFD setup. Start with the documentation structure and then automate the release pipeline.
Tech stack
dockerkubernetes
Domain
devopsinfrastructureclouddocumentationrelease
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitDockerKubernetesHelm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30