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: rework tutorial to not use global $ #1046

Merged
merged 3 commits into from
Jun 14, 2024
Merged

Conversation

Elfo404
Copy link
Member

@Elfo404 Elfo404 commented May 29, 2024

Still wip, i need to go through the content again.

I changed the "parameters" page to use functions and function parameters instead of a global config object, and reworked the following sections. I've also added a section at the end describing how to use a local config object to avoid some repetition but without the issues associated with having it as a global.

Fixes #816

Copy link

github-actions bot commented May 29, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-06-14 12:47 UTC

Copy link
Contributor

@zerok zerok left a comment

Choose a reason for hiding this comment

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

Looks good :) I think solving the configuration aspect with parameters is much more readable compared to merging 👍

docs/src/content/docs/tutorial/abstraction.md Outdated Show resolved Hide resolved
docs/src/content/docs/tutorial/k-lib.mdx Outdated Show resolved Hide resolved
docs/src/content/docs/tutorial/parameters.md Outdated Show resolved Hide resolved
Co-authored-by: Horst Gutmann <horst.gutmann@grafana.com>
@Elfo404
Copy link
Member Author

Elfo404 commented Jun 4, 2024

Cool! i'll find some time to rerun through the content again, probably reword a couple of things and then open it up for review

@Elfo404 Elfo404 marked this pull request as ready for review June 7, 2024 13:36
@Elfo404 Elfo404 requested a review from zerok June 7, 2024 13:36
docs/src/content/docs/tutorial/abstraction.md Outdated Show resolved Hide resolved
Co-authored-by: Horst Gutmann <horst.gutmann@grafana.com>
@Elfo404 Elfo404 merged commit f4103b5 into main Jun 14, 2024
5 checks passed
@Elfo404 Elfo404 deleted the gio/docs/fix-tutorial branch June 14, 2024 12:47
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.

Tutorial design results in runtime error
2 participants