Skip to content

Conversation

@SamarthJejurkar
Copy link

No description provided.

@SamarthJejurkar SamarthJejurkar requested a review from a team as a code owner November 13, 2024 12:05
@nicolastakashi
Copy link
Contributor

Hey @SamarthJejurkar thanks for that, can you check CI?

Comment on lines +49 to +54
<div class="col-lg-5">
<h2 class="h4">Exposing Prometheus and Alertmanager</h2>
<p>Learn how to expose Prometheus and Alertmanager services.</p>
<a href="/docs/platform-guides/exposing-prometheus-and-alertmanager/" class="btn btn-primary">Read More</a>
</div>

Copy link
Member

@AshwinSriram11 AshwinSriram11 Nov 14, 2024

Choose a reason for hiding this comment

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

There is no need to add this here. You are adding this div to the website's landing page.

cp repos/prometheus-operator/Documentation/troubleshooting.md content/docs/platform/troubleshooting.md
cp repos/prometheus-operator/Documentation/user-guides/storage.md content/docs/platform/storage.md
cp repos/prometheus-operator/Documentation/user-guides/strategic-merge-patch.md content/docs/platform/strategic-merge-patch.md
cp repos/prometheus-operator/Documentation/user-guides/exposing-prometheus-and-alertmanager.md content/docs/platform-guides/exposing-prometheus-and-alertmanager.md
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
cp repos/prometheus-operator/Documentation/user-guides/exposing-prometheus-and-alertmanager.md content/docs/platform-guides/exposing-prometheus-and-alertmanager.md
cp repos/prometheus-operator/Documentation/user-guides/exposing-prometheus-and-alertmanager.md content/docs/platform/exposing-prometheus-and-alertmanager.md

Copy link
Member

Choose a reason for hiding this comment

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

Platform-guide is the name of the section in the website while platform is the name of the folder in the repo.

Copy link
Member

@AshwinSriram11 AshwinSriram11 left a comment

Choose a reason for hiding this comment

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

Good start. I have added some comments. Feel free to ask your doubts.

@AshwinSriram11
Copy link
Member

You would also need to open a PR in the main repo where you add a header section to specify the position of the doc in the Platform-Guide section. It looks like this:

---
title: "API Reference"
images: []
lead: ""
weight: 150
draft: false
---

You can find it on each markdown file that is included in the website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants