Skip to content

Comments

Add Website Preview for New Documentation Page and Fixed Links#119

Merged
AshwinSriram11 merged 5 commits intoprometheus-operator:mainfrom
Dharma-09:main
Dec 23, 2024
Merged

Add Website Preview for New Documentation Page and Fixed Links#119
AshwinSriram11 merged 5 commits intoprometheus-operator:mainfrom
Dharma-09:main

Conversation

@Dharma-09
Copy link
Contributor

This pull request updates the synchronization.sh file in the website repository to include the new Prometheus & Alertmanager Exposure Guide.

Here is the first preview, confirming that the new documentation page is working as expected.

  1. Screenshot from 2024-12-14 12-57-36

The remaining screenshots state that the broken links have been fixed and no longer result in 404 errors.

Screenshot from 2024-12-14 13-09-49
Screenshot from 2024-12-14 13-09-43

@Dharma-09 Dharma-09 requested a review from a team as a code owner December 14, 2024 17:36
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.

Nice 👍 ! Just a few more things to watch for.

The tests are failing because it is trying to find the docs in the repo pulled from the main branch. Since you have pushed the changes to your branch, you need to update the repo source to pull the docs from your branch instead.

git clone https://github.com/prometheus-operator/prometheus-operator -b main --depth 1 repos/prometheus-operator

For now, you need to change it to your branch, something like this temporarily:

git clone https://github.com/Dharma-09/prometheus-operator -b main --depth 1 repos/prometheus-operator

@AshwinSriram11
Copy link
Member

Nice 👍 ! Just a few more things to watch for.

The tests are failing because it is trying to find the docs in the repo pulled from the main branch. Since you have pushed the changes to your branch, you need to update the repo source to pull the docs from your branch instead.

git clone https://github.com/prometheus-operator/prometheus-operator -b main --depth 1 repos/prometheus-operator

For now, you need to change it to your branch, something like this temporarily:

git clone https://github.com/Dharma-09/prometheus-operator -b main --depth 1 repos/prometheus-operator

After your PR in the main repo is merged, we can then change the source repo back to the main branch of prometheus-operator and it will work fine.

@AshwinSriram11
Copy link
Member

@Dharma-09 Can you change the source path in the synchronization file back to the original? With this, the page will be added to the website.

@AshwinSriram11 AshwinSriram11 merged commit b8f78cf into prometheus-operator:main Dec 23, 2024
3 checks passed
@AshwinSriram11
Copy link
Member

Thanks @Dharma-09

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.

2 participants