Skip to content

Commit

Permalink
docs: remove old docs folder and replace with new one (#2825)
Browse files Browse the repository at this point in the history
  • Loading branch information
mowies authored Jan 18, 2024
1 parent 731b9d4 commit e795c5a
Show file tree
Hide file tree
Showing 371 changed files with 111 additions and 18,056 deletions.
File renamed without changes.
File renamed without changes.
43 changes: 1 addition & 42 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ asdfg
authurl
automerge
automountserviceaccounttokenspec
autoprefixer
autoprovision
autoscaler
azurecr
Expand All @@ -60,20 +59,16 @@ batchai
baz
benbjohnson
bitnami
breadcrumb
btn
Buf
BUILDENVVAR
BUILDKIT
BUILDPLATFORM
buildx
CACHEDIR
cainjection
carryforward
certificatehandler
certmanager
certwebhook
changefreq
Chans
Checkmarx
clientgoscheme
Expand Down Expand Up @@ -115,7 +110,7 @@ ctrlcommon
ctx
curlcontainer
curlimages
currentversion
CURRENTVERSION
customresourcedefinitions
cwd
cyclomatic
Expand All @@ -142,8 +137,6 @@ deploymenttrace
dflags
distroless
Dockerfiles
docsearch
docsembed
docsy
donath
dql
Expand All @@ -156,14 +149,12 @@ dynatrace
ecr
elasticquota
elif
Emoji
ENABLEGITINFO
endblock
endgroup
envconfig
envsubst
envtest
errorf
errorlint
Etco
evaluatemetrics
Expand Down Expand Up @@ -194,10 +185,8 @@ funlen
Fxq
gaurav
gci
gcs
Generatable
getenv
getjson
getopt
gexec
gha
Expand All @@ -223,18 +212,13 @@ grafana
graphql
groupversion
gstatic
gtag
GVK
HCNAH
healthz
hellopy
helloworldtask
helmtests
helperfunctions
hidechildren
homedata
homeobservability
homeorchestrate
horizontalpodautoscalers
hpa
hsla
Expand All @@ -246,7 +230,6 @@ iak
IAnalysis
ICertificate
IConfig
iconx
IEvaluation
IEvent
iface
Expand Down Expand Up @@ -381,16 +364,13 @@ kustomizeconfig
kuttl
kwi
kwv
lastmod
lastword
Lato
LFC
Lifcycle
lifecyclekeptnsh
linenums
linkedin
linktitle
linting
livenessprobe
loadtests
LOCALBIN
Expand All @@ -400,7 +380,6 @@ makefiles
markdownfiles
markdownlint
markdownlintignore
markmap
matryer
maxdepth
MDL
Expand All @@ -420,7 +399,6 @@ mockserver
moq
mowies
mpod
multicard
multigroup
multipe
mutatingwebhookconfigurations
Expand All @@ -440,7 +418,6 @@ myversion
namespacedelete
Nde
netlify
Neue
nifi
nilnil
nindent
Expand Down Expand Up @@ -482,7 +459,6 @@ OUTDIR
overriden
owide
oyaml
pagelinks
PARAMSx
perc
persistentvolumeclaims
Expand All @@ -498,7 +474,6 @@ podtatohead
podtatometric
podtetohead
Pointlist
postcss
POSTDEPLOYMENTEVALUATIONSTATUS
POSTDEPLOYMENTSTATUS
postgres
Expand All @@ -508,7 +483,6 @@ PREDEPLOYMENTEVALUATIONSTATUS
PREDEPLOYMENTSTATUS
prepostdeployment
prepostevaluation
previewer
previousversion
printargs
printcolumn
Expand All @@ -524,24 +498,19 @@ pygments
pymdown
pymdownx
pyyaml
quickstart
rangespec
rangevalue
readfile
readinessprobe
readyz
realpath
redis
relref
remediations
replicasets
replicationcontrollers
resourcereference
Rexed
rgb
rgba
RLock
Roboto
rolebinding
rollme
roundtripper
Expand All @@ -561,7 +530,6 @@ sdkmetric
sdktest
sdktrace
secureparameters
Segoe
selfsigned
semconv
sendserviceaccount
Expand All @@ -577,7 +545,6 @@ sigstore
simpleapp
simplenode
simplenodeservice
sitemap
sli
slisslos
slo
Expand All @@ -590,15 +557,13 @@ spf
squidfunk
sre
stakeholders
standalone
statefulset
statefultest
stdouttrace
storageclasses
storageversion
sts
subchart
subdir
subfolders
subjectaccessreviews
substitue
Expand All @@ -609,7 +574,6 @@ SVCNAME
sync'ed
TARGETARCH
TARGETOS
targetserver
taskcontext
taskdef
taskdefinition
Expand Down Expand Up @@ -652,9 +616,6 @@ UIDs
undeploy
unmarshal
unmarshalling
urlset
usecasebox
usecases
usr
utilruntime
validatingwebhookconfigurations
Expand All @@ -678,7 +639,6 @@ webhookmanager
webhooknamespaces
website
whitespaces
whykeptn
Wiesinger
wjdp
wli
Expand All @@ -698,4 +658,3 @@ yannh
yml
YOURNAME
yourregistry
youtube
2 changes: 1 addition & 1 deletion .github/scripts/generate-crd-docs/generate-crd-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ RENDERER='markdown'
RENDERER_CONFIG_FILE_TEMPLATE_PATH='.github/scripts/generate-crd-docs/crd-docs-generator-config'
RENDERER_CONFIG_FILE=$RENDERER_CONFIG_FILE_TEMPLATE_PATH'.yaml'
PATH=$PATH:$(go env GOPATH)/bin
DOCS_PATH=./docs-new/docs/reference/api-reference/
DOCS_PATH=./docs/docs/reference/api-reference/

echo "Checking if code generator tool is installed..."
if ! test -s crd-ref-docs; then
Expand Down
26 changes: 0 additions & 26 deletions .github/scripts/generate-latest-doc.sh

This file was deleted.

1 change: 0 additions & 1 deletion .github/workflows/CI.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ on:
- 'epic/*'
paths-ignore:
- "docs/**"
- "docs-new/**"
- "**.md"
- "netlify.toml"
- "mkdocs.yml"
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/htmltest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ on:
- '[0-9]+.[1-9][0-9]*.x'
paths:
- 'docs/**'
- 'docs-new/**'
pull_request:
branches:
- 'main'
- '[0-9]+.[1-9][0-9]*.x'
paths:
- 'docs/**'
- 'docs-new/**'

jobs:
htmltest:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/markdown-checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,19 @@ jobs:

- name: Copy old docs
run: |
cp -R ./docs/content/en/docs/reference/api-reference ./docs/content/en/docs/reference/api-reference-old
cp -R ./docs/docs/reference/api-reference ./docs/docs/reference/api-reference-old
- name: Run docs generator
run: ./.github/scripts/generate-crd-docs/generate-crd-docs.sh

- name: Check if docs are up to date
run: |
if ! diff -rq ./docs/content/en/docs/reference/api-reference ./docs/content/en/docs/reference/api-reference-old &>/dev/null; then
if ! diff -rq ./docs/docs/reference/api-reference ./docs/docs/reference/api-reference-old &>/dev/null; then
echo "The CRD docs have changes that are not reflected in the docs pages."
echo "Please use ./.github/scripts/generate-crd-docs/generate-crd-docs.sh to re-generate the docs."
echo ""
echo "=========== Diff ==========="
diff -ru ./docs/content/en/docs/reference/api-reference ./docs/content/en/docs/reference/api-reference-old
diff -ru ./docs/docs/reference/api-reference ./docs/docs/reference/api-reference-old
exit 1
else
echo ""
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ readme-generator-for-helm/
/test.yaml
**helm_tests_output.yaml

/docs-new/site
/docs/site
4 changes: 2 additions & 2 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ config:
max-one-sentence-per-line: true

customRules:
- "./docs/rules/admonition.js"
- "./docs/rules/max-one-sentence-per-line.js"
- ".github/actions/markdown-lint-rules/admonition.js"
- ".github/actions/markdown-lint-rules/max-one-sentence-per-line.js"

ignores:
- "**/CHANGELOG.md"
Expand Down
13 changes: 5 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@ If not, go ahead and [create an issue](https://github.com/keptn/lifecycle-toolki
[good first issues](https://github.com/keptn/lifecycle-toolkit/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
If you want to work on it, just post a comment on the issue.

* **Add yourself**: Add yourself to the [list of contributors](CONTRIBUTORS.md)
along with your first pull request.

This document lays out how to get you started in contributing to
Keptn, so please read on.

Expand All @@ -43,21 +40,21 @@ on Slack and a mentor will surely guide you!
### Prerequisites

See
[Set up the development environment](docs/content/en/contribute/software/dev-environ/_index.md)
[Set up the development environment](https://keptn.sh/latest/docs/contribute/software/dev-environ/)
for information about how to set up an environment
in which you can develop and test software for Keptn.

## Related Technologies

Please check [Related Technologies](docs/content/en/contribute/general/technologies/_index.md).
Please check [Related Technologies](https://keptn.sh/latest/docs/contribute/general/technologies/).

## Linter Requirements

Please check [Linter Requirements](docs/content/en/contribute/docs/linter-requirements/_index.md).
Please check [Linter Requirements](https://keptn.sh/latest/docs/contribute/docs/linter-requirements/).

## Working with git

See [Working with Git](docs/content/en/contribute/general/git)
See [Working with Git](https://keptn.sh/latest/docs/contribute/general/git/)

Your PR will usually be reviewed by the Keptn team within a
couple of days, but feel free to let us know about your PR
Expand All @@ -67,5 +64,5 @@ couple of days, but feel free to let us know about your PR

All commits must be accompanied by a DCO sign-off.
See
[DCO](docs/content/en/contribute/general/dco)
[DCO](https://keptn.sh/latest/docs/contribute/general/dco/)
for more information.
Loading

0 comments on commit e795c5a

Please sign in to comment.