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 import.meta.resolve documentation #1691

Merged
merged 5 commits into from
Aug 13, 2024
Merged

Conversation

mstoykov
Copy link
Contributor

What?

Add documentation for grafana/k6#3873 and fix eslint to support it.

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).
  • I have made my changes in the docs/sources/next folder of the documentation.

Related PR(s)/Issue(s)

Copy link
Contributor

@joanlopez joanlopez left a comment

Choose a reason for hiding this comment

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

Not sure about ESLint configuration changes, but the rest looks good! 👍🏻
I left a couple of minor comments, but none is really blocking!

Co-authored-by: Joan López de la Franca Beltran <5459617+joanlopez@users.noreply.github.com>
@mstoykov
Copy link
Contributor Author

I don't really like the current way of the dedupping that means that they are shared documents for all the versions and opted to not try to fix this given the time constraint.

cc @heitortsergent - if you can point me how to reuse any file that will be nice.

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.

Left some small edits, thanks for adding these changes in @mstoykov! 🙇

docs/sources/next/javascript-api/_index.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/_index.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/import.meta/resolve.md Outdated Show resolved Hide resolved
@heitortsergent
Copy link
Collaborator

Also @mstoykov I didn't understand your comment about the shared documents for all the versions, could you please explain that to me? 🙏

We have this tutorial in the Writers' Toolkit about how to create shared content if that helps: https://grafana.com/docs/writers-toolkit/write/reuse-content/reuse-shared-content/

@heitortsergent heitortsergent mentioned this pull request Aug 13, 2024
5 tasks
mstoykov and others added 3 commits August 13, 2024 10:10
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@mstoykov
Copy link
Contributor Author

It seems I got confused by the way it is written and taught the shared files were under docs/shared instead of under docs/sources/<version>/shared which in that case means that the ones for v50 aren't the same as the one for v053.

So it is all good ! Sorry for the confusion.

@mstoykov mstoykov merged commit 706d47c into main Aug 13, 2024
5 checks passed
@mstoykov mstoykov deleted the feat/import.meta.resolve branch August 13, 2024 08:05
@heitortsergent
Copy link
Collaborator

I think the shared files can be in the docs/sources/<version>/shared for version-specific files, or under docs/sources/shared. Is that correct @jdbaldry? 🤓

@jdbaldry
Copy link
Member

I think the shared files can be in the docs/sources/<version>/shared for version-specific files, or under docs/sources/shared. Is that correct @jdbaldry? 🤓

I think in theory you can look up in either location. All the directories will be synced to the website repository and you can look up "unversioned" documentation by setting version="".

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.

5 participants