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

Fix/improve demo documentation #759

Merged

Conversation

mateusoliveira43
Copy link
Collaborator

@mateusoliveira43 mateusoliveira43 commented Jan 2, 2023

Describe the behavior changes introduced in this PR

I was running the Pelorus demo and decided to update the documentation on that part (but I ended up doing more and this became a big PR 😢).

The idea of this PR is to improve our documentation, focused on the Pelorus demo.

Linked Issues?

not closing ones.

Testing Instructions

Run the documentation locally, with

make dev-env
source .venv/bin/activate
mkdocs serve

and compare with our live documentation.

Depends on: #723 #690

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
@openshift-ci
Copy link

openshift-ci bot commented Jan 2, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign etsauer for approval by writing /assign @etsauer in a comment. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@mpryc
Copy link
Collaborator

mpryc commented Jan 3, 2023

/test 4.10-e2e-openshift

scripts/run-pelorus-e2e-tests Outdated Show resolved Hide resolved
Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
@mateusoliveira43
Copy link
Collaborator Author

I would change the order of philosophy and getting started, what you think?

@weshayutin
Copy link
Contributor

@mpryc this will likely conflict w/ https://github.com/konveyor/pelorus/pull/723/files which imho we should hurry up and merge.

@mateusoliveira43 mateusoliveira43 added the docs Documentation issue label Jan 4, 2023
Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
@mateusoliveira43
Copy link
Collaborator Author

Applied some changes from #723

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
@mpryc
Copy link
Collaborator

mpryc commented Jan 9, 2023

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 9, 2023
@mpryc mpryc merged commit 7ed0903 into dora-metrics:master Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes docs Documentation issue lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants