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.

Sign up for GitHub

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

Jump to bottom

Use code annotations to increase usability of Analysis reference page #3040

Open
mowies opened this issue Feb 13, 2024 · 9 comments
Open

Use code annotations to increase usability of Analysis reference page #3040

mowies opened this issue Feb 13, 2024 · 9 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mowies
Copy link
Member

mowies commented Feb 13, 2024 •
edited

Details

The Analysis CRD reference page (link)
has a big code example which is then explained below in lots of detail.

This explanation is the perfect fit to use code annotations
from mkdocs-material.
@mowies mowies added documentation Improvements or additions to documentation good first issue Good for newcomers status: ready-for-refinement Issue is relevant for the next backlog refinment labels Feb 13, 2024
@VamshiReddy02
Copy link
Contributor

I would love to work on this issue. But can you give me more information, on where to add annotations like sub-heading?
and also the link is not working.

@mowies
Copy link
Member Author

mowies commented Feb 13, 2024

link is fixed 👍🏼

@odubajDT odubajDT removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Feb 14, 2024
@VamshiReddy02
Copy link
Contributor

Hey @mowies, Can I work on this issue?

@mowies
Copy link
Member Author

mowies commented Feb 20, 2024

sure!

@odubajDT
Copy link
Contributor

Hi @VamshiReddy02 any updates on this issue?

@VamshiReddy02
Copy link
Contributor

working on it, will be creating a PR soon!

@VamshiReddy02 VamshiReddy02 mentioned this issue Mar 2, 2024
Closed
@odubajDT
Copy link
Contributor

odubajDT commented Apr 2, 2024

Hi @VamshiReddy02 are you actively working on this issue? Since there is no activity on your PR for a few weeks, we usually unassign asignees from their issues to not block other potential contributors from starting to tackle them.

Thanks for the update!

@VamshiReddy02
Copy link
Contributor

Sorry, @odubajDT for not providing any updates regarding this PR. Due to some other commitments, I'll have to close this PR.

@VamshiReddy02 VamshiReddy02 removed their assignment Apr 2, 2024
@odubajDT
Copy link
Contributor

odubajDT commented Apr 3, 2024

Thank you for your update!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Keptn Lifecycle Toolkit
Status: 🎟️ Refined
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: added code annotations feature in Analysis reference page VamshiReddy02/lifecycle-toolkit
3 participants
@mowies @odubajDT @VamshiReddy02