Skip to content

Commit

Permalink
Merge branch 'main' into release-please--branches--main--components--…
Browse files Browse the repository at this point in the history
…scheduler
  • Loading branch information
RealAnna authored Jun 27, 2024
2 parents d80edc2 + 65211fe commit 3e2065a
Show file tree
Hide file tree
Showing 11 changed files with 63 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/blog/posts/using-keptn-analyses-in-argo-workflows.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-06-03
date: 2024-06-27
authors: [bacherfl]
description: >
In this blog post you will learn how to use the Analysis feature of Keptn within Argo Workflows.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/certificate-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ automatically renewed.

If you don't want to use Keptn Cert Manager, you can instead
use [cert-manager.io](../installation/configuration/cert-manager.md)
for this purpose.
for this purpose.
6 changes: 6 additions & 0 deletions docs/docs/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ It is divided into three sections:
gives additional guidelines that apply only to documentation contributions
and describes the documentation file structure
and the documentation tools we use.

* [Website contributions](website/index.md)
provides relevant information for contributing
to the website, including all the file directories and
files used to modify the website, and instructions for
testing and verifying changes before submitting.
35 changes: 35 additions & 0 deletions docs/docs/contribute/website/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
comments: true
---

# Contribute to the Website

This section provides information on how to contribute to the website.

## Location of Files Used to Modify the Website

Here are some key files and directories:

- **`docs/assets/`**: This directory contains all the stylesheets and
javascript files.
- **`docs/overrides/`**: This directory contains all the html files.
- **`docs/website.yml`**: This file contains configurations specific to the
website, such as all the directories.
- **`mkdocs.yml`**: The main configuration file for MkDocs.
It defines the structure and configuration of the documentation site.

## How to Test/Verify Changes

To test and verify changes before submitting:

- Make your changes in a new branch.
- Open a pull request.
- The changes will be reflected in the ReadTheDocs preview for the PR.
- Review the preview to ensure your changes are correct.

## Building the Website Locally

To see your changes live on your local machine, follow the steps described in the
[Building Documentation Locally](../docs/local-building.md) guide.
This guide provides detailed instructions on how to set up a local MkDocs build
environment.
4 changes: 3 additions & 1 deletion docs/docs/getting-started/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,9 @@ Save this file as `values.yaml`:
```yaml
grafana:
adminPassword: admin
sidecar.datasources.defaultDatasourceEnabled: false
sidecar:
datasources:
defaultDatasourceEnabled: false
prometheus:
prometheusSpec:
additionalScrapeConfigs:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/installation/configuration/cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@ for more details.

## Troubleshooting

When experiencing problems with setting up cert-manager.io,
When experiencing problems with setting up cert-manager.io,
please refer to the
[cert-manager.io troubleshooting page](https://cert-manager.io/docs/troubleshooting/).
[cert-manager.io troubleshooting page](https://cert-manager.io/docs/troubleshooting/).
10 changes: 10 additions & 0 deletions docs/website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
contribution_guide:
directories:
website_files:
HTML_files:
- first_path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/overrides"
- second_path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/overrides/partials"
stylesheet_files:
- path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/assets/stylesheets"
javascript_files:
- path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/assets/javascripts"
Original file line number Diff line number Diff line change
Expand Up @@ -805,4 +805,4 @@ metadata:
name: grafana-dashboard-keptn-applications
namespace: monitoring
labels:
grafana_dashboard: "0"
grafana_dashboard: "1"
Original file line number Diff line number Diff line change
Expand Up @@ -891,4 +891,4 @@ metadata:
name: grafana-dashboard-keptn-overview
namespace: monitoring
labels:
grafana_dashboard: "0"
grafana_dashboard: "1"
Original file line number Diff line number Diff line change
Expand Up @@ -639,4 +639,4 @@ metadata:
name: grafana-dashboard-keptn-workloads-dora
namespace: monitoring
labels:
grafana_dashboard: "0"
grafana_dashboard: "1"
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -234,5 +234,7 @@ nav:
- Blogs: docs/contribute/docs/blog.md
- Published doc structure: docs/contribute/docs/publish.md
- Word list: docs/contribute/docs/word-list.md
- Website Contributions:
- docs/contribute/website/index.md
- Blog:
- blog/index.md

0 comments on commit 3e2065a

Please sign in to comment.