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 link to GitHub source code for all jslib libraries #1757

Merged
merged 4 commits into from
Oct 3, 2024

Conversation

heitortsergent
Copy link
Collaborator

What?

Add an admonition at the top of all jslib libraries _index pages with a link to their GitHub repositories.

Checklist

  • 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 npm start 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 folders of the two previous k6 versions of the documentation (if still applicable to previous versions).

@heitortsergent heitortsergent self-assigned this Oct 2, 2024
@heitortsergent heitortsergent requested a review from yorugac October 2, 2024 14:33
@heitortsergent heitortsergent added Area: OSS Content Improvements or additions to community/oss documentation type/docs labels Oct 2, 2024
Copy link
Contributor

@yorugac yorugac left a comment

Choose a reason for hiding this comment

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

This looks great, IMO! Thanks to the colored note, the links are even more obvious than I hoped initially 🙌 Thank you @heitortsergent 💛

I've left a suggestion about a couple of links, that they should be more precise: this is my opinion as a user browsing documentation 🙂

For posterity's sake, attaching how it looks now:
image

image

@heitortsergent
Copy link
Collaborator Author

Thanks for the review @yorugac. 🙇

@heitortsergent heitortsergent marked this pull request as ready for review October 3, 2024 16:15
@heitortsergent heitortsergent merged commit 7d7085a into main Oct 3, 2024
5 checks passed
@heitortsergent heitortsergent deleted the hts/update-jslib-gh-links branch October 3, 2024 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OSS Content Improvements or additions to community/oss documentation type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants