Skip to content
This repository was archived by the owner on Jan 11, 2024. It is now read-only.

Restructure docs regarding shipyard file#815

Merged
christian-kreuzberger-dtx merged 2 commits intomasterfrom
feature/add_remediation_sequence
May 18, 2021
Merged

Restructure docs regarding shipyard file#815
christian-kreuzberger-dtx merged 2 commits intomasterfrom
feature/add_remediation_sequence

Conversation

@christian-kreuzberger-dtx
Copy link
Copy Markdown
Member

@christian-kreuzberger-dtx christian-kreuzberger-dtx commented May 17, 2021

As part of keptn/examples#166 I took the chance and restructured our docs regarding Shipyard file.

  1. I believe that there was too much information hidden in the Continuous delivery section, hence I have moved it out to the Manage Keptn/Shipyard section.
    image
    Preview: https://deploy-preview-815--keptn.netlify.app/docs/0.8.x/manage/shipyard/

  2. I have also added an example of adding a remediation sequence to the Update shipyard docs (Preview: https://deploy-preview-815--keptn.netlify.app/docs/0.8.x/manage/shipyard/#add-remove-a-task-sequence-to-from-a-stage scroll down to Use Case 2)

  3. Multi-stage continuous-delivery has been extended by multiple examples. Preview: https://deploy-preview-815--keptn.netlify.app/docs/0.8.x/continuous_delivery/multi_stage/

  4. A basic example for a remediation sequence was added in Automated Operations / Remediation Config. Preview: https://deploy-preview-815--keptn.netlify.app/docs/0.8.x/automated_operations/remediation/
    image

  5. Update project instructions have been slightly adapted. Preview: https://deploy-preview-815--keptn.netlify.app/docs/0.8.x/manage/project/#update-a-project

@github-actions
Copy link
Copy Markdown

Misspellings found, please review:

  • singlestage
To accept these changes, run the following commands from this repository on this branch
pushd $(git rev-parse --show-toplevel)
perl -e '
my @expect_files=qw('".github/actions/spelling/expect.txt"');
@ARGV=@expect_files;
my @stale=qw('"ABCDEF acceptederrorrate acceptederrors addgroup addrowonbottom adduser agrabner AKS alecthomas alertname andi andreas anyuid aot apimachinery apimodels apisecret apiutils apk Appk argjson Arial asaskevich asc Assertf atob Atoi attr autocomplete automaticversioncheck autorepair avgrtvalidation axios bacherfl backports bak barista bestpractices Bitbucket blacklistip bookinfo bookratings boop bqw bracebin braeuer bridgesecret bridgeversion browserslist bson btn buf bufio bugfix bugfixes bugzilla buildflags BUILDIR carryforward cartsloadgen CAs cdk cenats cespec cfg cgi CGO CHACHA chartutil checkip ciphersuite ckf CLA classlist classpath clientcmd clientset CLN cloudevents cloudsdk CLZ cmdutil cmp codebase codecov codelyzer codeowners combi commitlink commonjs compat concat configmodels configservice configurationchanger configurationserviceconnection configurationstore configurator configuremonitoring configutils consumercatalog containerregistry coreinfrastructure cors cov covermode coverprofile crds CREATEBIN createrelease credentialmanager criticalevent cron css cta cyberciti daemonset danielkhan dasharray dataservice datetime Davila dbg DDTHH Debian deletecollection depd depl deploymentdescriptions DEPS devkit devtools dirname distractor dockerfile dockerhub doctype dominikmessner dompurify downlevel dpl dracula dropdown dst dtx dvcm dynatraceheader EAP easytravel ECDHE ECDSA echosequence EKS elif Emoji endpointurl entrypoint enum envoyproxy epochconverter eql ermin errorable Errorf errorformat errstr eslint esnext Eter euo evaluationmanager evaluationsdetails eventrepo eventselector eventsender Evts exechelper externallink Fairwinds Fatalln favicon filepath filetype firststage flagext fluentbit forwardedfor Fprintf Fprintln fptr fromdate Frontmatter fsgroups fullname funcvalidation fwlink gcc gcflags gendoc genericclioptions Getenv getpostman GFzc ghodss gitcommit githubusercontent globalsign goarch GOBIN godep godoc gofmt gohugoio goland golangswaggerpaths golint gomock gomod gonic GOPATH gopkg GOPROXY goreportcard GOTRACEBACK goutils goutilsmodels govalidator gpg grabnerandi grpc gsutil gtr gtrp guiclass gunzip gw halem hammerjs hardenings hashicorp healthcheck Helch helmservice highcharts hljs homedir hotfixes HTT httprequest HTTPSTATUS httptest hyperv IChart ico IConfiguration IDOK IDQ IDURL idx IEvaluation IEvent IMPL INamespace inferrable Infof inp instanceof Intelli ioutil ipaddress IProject IRemediation ISecret IService IShipyard istage istioctl itf Itoa jasminewd JCHECK JDT jenkinsjob jeremywohl jessevdk jetbrains jetzlstorfer JKEPTN JLoop JM jmeterconf jmeterservice JPROTOCOL jre jsdoc JSERVER jsonassert jsonschema JSONTo JThink JVU JWT keepalive kelseyhightower Kepn keptnapi keptnapimodels keptncommon keptndev keptnkubeutils keptnlabel keptnmodels keptnservices keptnutils keptnversion keychain keyframes keygen keyvalue Kibana kinbiko kjhtml Knative kreuzberger ktb kubeclient kvm kyaml lastversioncheck lcovonly Ldate ldflags len libc libnpx lifecycle linkcolor linkid linkmode linting linuxunix listchecker listentry loadgen lodash Logf logrus loopcount Lshortfile Ltime MAKEFLAGS mapfile mapstructure matryer mattn mdbrepo meb mgo mholt middleware minimist minishfit minishift minwidth misconfigurations mitchellh mktemp mng mockgen mongoexport mongoimport mongosecret monorepo moq mousemove mozilla mpfosi mptr mtls muratovic mutex MVJSON myapp myclientcert mydbserver mygateway mygroup myjmeter mykey myprojec myproject myredissrv myremediationlink myuser myvalue namespacemanager Nano natsbox nc nch netutil Neue newartifact newcatalog newratings NEWVAL ngrx ngx nightlies nindent nobreak nodemon nodeport nokubectl noname noopener Nop noreferrer noreply noscript notin Noto nowrap npm npx nss nvie objectutils OIFS ojson okm OLDPWD OLDVAL omitempty onboarder onboards onclick oneof openapi openapierrors openjdk orgs oss osxkeychain otiai owasp padchar params pb pem perc perfservice php pid pinnable pipefail ple poddescriptions podlogs polyfills prebuilt preemptible prepender printf prj problemdetails productpage PROJ projectes projectmanager PROJECTNAME projectrepo PROJECTROOT protobuf protoc Protos Psampler ptr ptrp pubsub PVs qhk quotemark RDWR redis Redoc refactor referer refname regexp Reitbauer releasename releasenotes replicacount repolink restapi resultdirectory reviewdog rgb rgba rhk riggaroo RLock roadmap Roboto rockstar rollme rootcacerts Routable rowsize rsa rsp runasuser runlocal RUnlock rxjs samuelfahrngruber sandroschmid scc scopesrepository scss secondstage secretbackend secretstore secuirtycontextconstraints securitycontextconstraints Segoe selfmon selfmonitoring selfservice serr serrors servicemanager servicename servicetype serviceutils shellcheck shellscripts shellwords shipyardversion SIGINT SIGTERM simplenode simplenodeservice simpleproject sirupsen skaffold Smode sni sockshot sourceip ssh ssl Sta'lone stackoverflow Stacktrace stagemanager stakeholders stdduration Stderr stdin stdout strarr strconv strfmt stringify stringp stylesheet subfolder Submatch submatches subrequest sutils svcs svg swaggo syscall tabwidth tabwriter tasksequencerepo templating Testcase testclass testdeploy testname testversion textarea thinktime thirdstage threadgroup tlf tls TLSCA tmpfile todo tokenizer TOKENLEN totalscore tpl TRANSLIT travisbuild treemap trunc tsc tsconfig tslib tslint ttl typeof TZ tzdata uarr ucd ucdr uem uid uint unarchive uncomment unescape unmarshal unmarshaling unmarshall unmarshalling unsubscribe upgradable upgradeable upgradecollections uprinc upstreams URINo URIOK URITo URIURL urlencoded useragent USSH utc UTILDIR validator vals varint versioncheck versioning virtualbox virtualisation vuser Vwd webkit webpack whitespaces wiki wikipedia wildcards wincred WORKDIR wpcatalog Writeln xargs xhr xit XNlcg xolv XPOST XToken XVersion YAMLTo YOURURL "');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
  if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
  next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
make_path ".github/actions/spelling";
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"aks bitbucket cla CODEOWNERS COMPAT Dockerfile eap emoji FILEPATH GPG jm KEPTNVERSION Keychain kibana knative Mgo Minishift Nc Onboards Printf projectname PUBSUB reitbauer Reviewdog SERVICENAME singlestage SSL TODO tz Versioning Wincred "');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a) cmp lc($b)} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;'
popd

… example

Signed-off-by: Christian Kreuzberger <christian.kreuzberger@dynatrace.com>
Comment thread content/docs/0.8.x/continuous_delivery/multi_stage/index.md Outdated
Comment thread content/docs/0.8.x/continuous_delivery/multi_stage/index.md Outdated
Comment thread content/docs/0.8.x/continuous_delivery/multi_stage/index.md Outdated
Comment thread content/docs/0.8.x/continuous_delivery/multi_stage/index.md
Comment thread content/docs/0.8.x/continuous_delivery/multi_stage/index.md
Comment thread content/docs/0.8.x/manage/project/index.md Outdated
Comment thread content/docs/0.8.x/manage/shipyard/index.md Outdated
Comment thread content/docs/0.8.x/manage/shipyard/index.md Outdated
- name: "release"
```

### Reserved Keptn Tasks
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it that you moved this section to this page.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still need to make sure we update this section regularly. It gets outdated so quickly...

Signed-off-by: Christian Kreuzberger <christian.kreuzberger@dynatrace.com>
@christian-kreuzberger-dtx christian-kreuzberger-dtx marked this pull request as ready for review May 18, 2021 07:41
Copy link
Copy Markdown
Member

@johannes-b johannes-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@christian-kreuzberger-dtx christian-kreuzberger-dtx merged commit c340ab3 into master May 18, 2021
@christian-kreuzberger-dtx christian-kreuzberger-dtx deleted the feature/add_remediation_sequence branch May 18, 2021 09:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants