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

docs: improve guide page section #3170

Merged
merged 4 commits into from
Apr 2, 2024
Merged

docs: improve guide page section #3170

merged 4 commits into from
Apr 2, 2024

Conversation

YashPimple
Copy link
Member

@YashPimple YashPimple commented Mar 2, 2024

Description:

Enhances the consistency of page titles under the "guides" section to provide a more user-friendly navigation experience for Keptn users.

Fixes #2921

Changes made

  • updated the navigation structure in the MkDocs file to reflect the modified page titles.
  • ensured that main keyword/topic is placed at the beginning of each page title.

Checklist

  • My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • I signed off all my commits according to the Developer Certificate of Origin (DCO)
    see Contribution Guide
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My code follows the style guidelines of this project (golangci-lint passes, YAMLLint passes)
  • I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation (if needed)
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)
  • New and existing unit and integration tests pass locally with my changes

Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
@YashPimple YashPimple requested review from a team as code owners March 2, 2024 18:34
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 2, 2024
Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
@odubajDT
Copy link
Contributor

Hi @YashPimple any updates on this?

@YashPimple
Copy link
Member Author

Hi @YashPimple any updates on this?

Hii @odubajDT I have made the suggested changes prior only it just need to get reveiwed

odubajDT
odubajDT previously approved these changes Mar 28, 2024
docs/docs/guides/index.md Outdated Show resolved Hide resolved
Co-authored-by: Florian Bacher <florian.bacher@dynatrace.com>
Signed-off-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Copy link

sonarcloud bot commented Apr 2, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@odubajDT odubajDT merged commit 445abf3 into keptn:main Apr 2, 2024
11 checks passed
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
Signed-off-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Co-authored-by: Florian Bacher <florian.bacher@dynatrace.com>
Signed-off-by: vickysomtee <vickysomtee@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make guide page titles consistent and easier to find
3 participants