Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs and workflow for pusblish them #18

Merged
merged 1 commit into from
Nov 28, 2023

Conversation

morenod
Copy link
Collaborator

@morenod morenod commented Nov 7, 2023

Type of change

  • Refactor
  • New feature
  • Bug fix
  • Optimization
  • Documentation Update

Description

Add docs and CI for publishing them using mk-docs

Related Tickets & Documents

  • Related Issue #
  • Closes #

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.

@rsevilla87
Copy link
Member

Do you have a preview link?

@morenod
Copy link
Collaborator Author

morenod commented Nov 8, 2023

Do you have a preview link?

https://morenod.github.io/rosa-burner

docs/index.md Outdated

Following platforms are available at this moment:

- Rosa
Copy link
Member

Choose a reason for hiding this comment

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

This is a bit confusing
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

modified

docs/index.md Outdated

Rosa-burner is a wrapper to automate create-use-destroy of OCP clusters in the different managed platforms.

## How works rosa-burner
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
## How works rosa-burner
## How rosa-burner works

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

Copy link
Member

@krishvoor krishvoor left a comment

Choose a reason for hiding this comment

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

ptal at the review comments

mkdocs.yml Outdated
Comment on lines 12 to 15
- Observability & alerting:
- observability/index.md
- Overview: observability/index.md
- Indexing: observability/indexing.md
Copy link
Member

Choose a reason for hiding this comment

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

If we plan on adding content here, please update these to below:

- Observability & alerting:
  - docs/observability/index.md
  - Overview: docs/observability/index.md
  - Indexing: docs/observability/indexing.md

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

removed

Comment on lines 3 to 5
- asdf
- asdf
- asdfasfd
Copy link
Member

Choose a reason for hiding this comment

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

Can you ptal this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

added info on measurements

@morenod morenod merged commit 146e080 into cloud-bulldozer:main Nov 28, 2023
3 checks passed
@morenod morenod deleted the readme branch June 3, 2024 08:46
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