Skip to content

Commit bcc3741

Browse files
committed
Add some placeholder files for structure
Signed-off-by: Robert Detjens <github@detjens.dev>
1 parent 2598a9c commit bcc3741

File tree

7 files changed

+21
-5
lines changed

7 files changed

+21
-5
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
schema reference

docs/for-challenge-authors.md renamed to docs/for-authors/quickstart.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# How to write beaverCDS challenge.yaml config
1+
# Challenge Config Quickstart
22

3-
tldr: see [the TCP example](#full-tcp-example) or [the web example](#full-http-example).
3+
All information about a challenge is configured in a `challenge.yaml` in the
4+
challenge's directory in the repo, generally `<category>/<name>`.
5+
6+
For a tldr: see a full example for [a TCP/`nc` challenge](#full-tcp-example) or [a web challenge](#full-http-example).
47

58
### Metadata
69

@@ -112,15 +115,15 @@ provide:
112115
# file from the challenge folder in the repo
113116
- somefile.txt
114117
115-
# multiple files from chal_folder/src/, zipped as together.zip
118+
# multiple files from src/ in the challenge folder, zipped as together.zip
116119
- as: together.zip
117120
include:
118121
- src/file1
119122
- src/file2
120123
- src/file3
121124
122-
# extract these files from inside of the container image
123-
# for the `main` pod (see previous section)
125+
# multiple files pulled from the container image for the `main` pod
126+
# (see previous Pods section)
124127
- from: main
125128
include:
126129
- /chal/notsh
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
architecture of deployed resources

docs/for-sysadmins/config.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# rcds.yaml
2+
3+
`rcds.yaml` is the 'global' config for beaverCDS. This defines what challenges are available, where to deploy them to, and what credentials to use for building and deploying them.
4+
5+
This will always be at `/rcds.yaml` in the challenges repository.

docs/for-sysadmins/install.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
installing beavercds

docs/for-sysadmins/quickstart.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
quick install instructions
2+
requirements - cluster, registry, bucket
3+
cluster-setup
4+
configuring rcds.yaml

docs/repo-structure.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
expected layout of challenges repo

0 commit comments

Comments
 (0)