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 manual section on modular configurations #1841

Merged
merged 3 commits into from
Mar 11, 2024
Merged

Add manual section on modular configurations #1841

merged 3 commits into from
Mar 11, 2024

Conversation

yannham
Copy link
Member

@yannham yannham commented Mar 8, 2024

Closes #1394.

This PR imports the Tweag blog post about the Nickel merge system (https://www.tweag.io/blog/2023-11-02-nickel-merge-system/) into the manual almost verbatim (beside a few trivial changes such as "post" -> "section"). This blog post explores how to use the merging system to write modular configurations, which isn't covered currently in the manual.

@yannham yannham requested review from vkleen and jneem March 8, 2024 14:48
@github-actions github-actions bot temporarily deployed to pull request March 8, 2024 14:52 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 8, 2024 15:28 Inactive
@yannham
Copy link
Member Author

yannham commented Mar 8, 2024

I'm waiting for #1843, which might be required to make the CI pass.

This commit import the Tweag blog post on the Nickel merge system
(https://www.tweag.io/blog/2023-11-02-nickel-merge-system/) into the
manual almost verbatim (beside a few trivial changes such as "post" ->
"section"). This blog post explores how to use the merging system to
emulate a form of modules, and thus write modular configurations, which
isn't covered currently.
@github-actions github-actions bot temporarily deployed to pull request March 8, 2024 16:09 Inactive
@yannham
Copy link
Member Author

yannham commented Mar 11, 2024

This is all good now, ready for review and CI is green @jneem @vkleen

Nickel is currently released in version `1.3`. We expect the core design of the
language to be stable and the language to be useful for real-world applications.
The next steps we plan to work on are:
Nickel is currently released in version `1.4`. The core design of the language
Copy link
Contributor

Choose a reason for hiding this comment

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

Did we forget updating that, again? Or did this change sneak in from somewhere elese?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we just didn't update it. We updated it in the README probably, but not here, and sadly the introduction is just a copy of a part of the README.

doc/manual/modular-configurations.md Outdated Show resolved Hide resolved
doc/manual/modular-configurations.md Outdated Show resolved Hide resolved
doc/manual/modular-configurations.md Outdated Show resolved Hide resolved
doc/manual/modular-configurations.md Outdated Show resolved Hide resolved
doc/manual/modular-configurations.md Outdated Show resolved Hide resolved
doc/manual/modular-configurations.md Outdated Show resolved Hide resolved
Co-authored-by: Viktor Kleen <viktor.kleen@tweag.io>
@github-actions github-actions bot temporarily deployed to pull request March 11, 2024 15:49 Inactive
Co-authored-by: Viktor Kleen <viktor.kleen@tweag.io>
@yannham yannham enabled auto-merge March 11, 2024 16:08
@github-actions github-actions bot temporarily deployed to pull request March 11, 2024 16:11 Inactive
@yannham yannham added this pull request to the merge queue Mar 11, 2024
Merged via the queue into master with commit 71a84b3 Mar 11, 2024
5 checks passed
@yannham yannham deleted the doc/modules branch March 11, 2024 16:37
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.

Add a section on configuration modules
2 participants