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 jslib-aws links & general improvements to that specific section #1453

Merged
merged 5 commits into from
Dec 27, 2023

Conversation

oleiade
Copy link
Member

@oleiade oleiade commented Dec 12, 2023

What?

As I was supporting a user with jslib-aws, I noticed that the docs' jslib/aws section needed some love. Some links were broken or plainly displayed as markdown.

Thus in this PR I:

  • renamed markdown files for clarity
  • renamed pages for clarity in the sidebar
  • fixed broken links
  • miscellaneous tiny changes

This is a massive PR, I wouldn't recommend checking every changes individually, but if you could take it for a spin locally and verify that everything looks in order, I'd be grateful 🙇🏻

Checklist

Please fill in this template:

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the make docs command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/next folder of the documentation.
  • I have reflected my changes in the docs/sources/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the relevant (e.g. when correcting a documentation error) folders of the previous k6

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

@oleiade thanks for all these improvements!! I went through a few of the changes locally and tested out the links, and everything looks good.

I left a few comments that are all the same, we have a general rule for the Grafana docs that the title front matter property should match the h1 heading for the page. Do you want me to go through and fix those in the PR for you? I think once that's fixed we can merge it. :shipit:

@oleiade
Copy link
Member Author

oleiade commented Dec 20, 2023

Thanks a lot for the review @heitortsergent I've applied the change to the next, 48, and 47 version folders, and also added weights to keep the sections organized 👍🏻

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

Thanks @oleiade! I did a quick scan and found just one h1 title that still had a (), everything else looks good! Feel free to merge when you're ready :shipit:.

…ys.md

Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@oleiade
Copy link
Member Author

oleiade commented Dec 27, 2023

Noice! Thanks a lot for your help @heitortsergent this was a big one!!

@oleiade oleiade merged commit 35d7152 into main Dec 27, 2023
6 checks passed
@oleiade oleiade deleted the fix/jslib-aws-signature branch December 27, 2023 15:49
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.

None yet

2 participants